X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=d706dad9582035dcadb4311ddd3455441468ff05;hb=9867896b122160ea5d8e6dbccba4cc5916bf523b;hp=e8b72506f4c49ce6987cf3c620b54dd1296f57f9;hpb=323daa7f98fd16385379e4b6e8def0a9a3f140c8;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index e8b72506..d706dad9 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,13 +1,13 @@ -IPool | poolifier - v2.6.36
+IPool | poolifier - v2.6.45
-
+
  • The search index is not available
  • poolifier - v2.6.45 +
    @@ -46,15 +46,15 @@ +
  • Defined in src/pools/pool.ts:205
  • - +

    Properties

    - +
    destroy: (() => Promise<void>)

    Type declaration

    @@ -83,7 +84,7 @@

    Returns Promise<void>

    +
  • Defined in src/pools/pool.ts:262
  • emitter?: PoolEmitter
    @@ -91,7 +92,7 @@

    Events that can currently be listened to:

    • 'ready': Emitted when the number of workers created in the pool has reached the minimum size expected and are ready.
    • -
    • 'busy': Emitted when the number of workers created in the pool has reached the maximum size expected and are executing at least one task.
    • +
    • 'busy': Emitted when the number of workers created in the pool has reached the maximum size expected and are executing concurrently their tasks quota.
    • 'full': Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.
    • 'destroy': Emitted when the pool is destroyed.
    • 'error': Emitted when an uncaught error occurs.
    • @@ -101,7 +102,7 @@
    +
  • Defined in src/pools/pool.ts:241
  • enableTasksQueue: ((enable, tasksQueueOptions?) => void)
    @@ -120,15 +121,17 @@
  • enable: boolean

    Whether to enable or disable the worker node tasks queue.

    -
  • +
    +
  • Optional tasksQueueOptions: TasksQueueOptions

    The worker node tasks queue options.

    -
    Optional
  • + +

    Returns void

    +
  • Defined in src/pools/pool.ts:293
  • execute: ((data?, name?, transferList?) => Promise<Response>)
    @@ -147,20 +150,23 @@
  • Optional data: Data

    The optional task input data for the specified task function. This can only be structured-cloneable data.

    -
    Optional
  • + +
  • Optional name: string

    The optional name of the task function to execute. If not specified, the default task function will be executed.

    -
    Optional
  • + +
  • Optional transferList: TransferListItem[]

    An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the pool's worker_threads worker and they should not be used in the main thread afterwards.

    -
    Optional
  • + +

    Returns Promise<Response>

    Promise that will be fulfilled when the task is completed.

    +
  • Defined in src/pools/pool.ts:250
  • hasWorkerNodeBackPressure: ((workerNodeKey) => boolean)
    @@ -179,12 +185,13 @@
  • workerNodeKey: number

    The worker node key.

    -
  • + +

    Returns boolean

    true if the worker node has back pressure, false otherwise.

    +
  • Defined in src/pools/pool.ts:227
  • info: PoolInfo
    @@ -192,7 +199,7 @@
    +
  • Defined in src/pools/pool.ts:213
  • listTaskFunctions: (() => string[])
    @@ -209,7 +216,7 @@
    +
  • Defined in src/pools/pool.ts:268
  • setTasksQueueOptions: ((tasksQueueOptions) => void)
    @@ -228,11 +235,12 @@
  • tasksQueueOptions: TasksQueueOptions

    The worker node tasks queue options.

    -
  • + +

    Returns void

    +
  • Defined in src/pools/pool.ts:302
  • setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void)
    @@ -251,15 +259,17 @@
  • workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"

    The worker choice strategy.

    -
  • + +
  • Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions

    The worker choice strategy options.

    -
    Optional
  • + +

    Returns void

    +
  • Defined in src/pools/pool.ts:275
  • setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)
    @@ -278,11 +288,28 @@
  • workerChoiceStrategyOptions: WorkerChoiceStrategyOptions

    The worker choice strategy options.

    -
  • + +
    +

    Returns void

    +
    +
    + +
    start: (() => void)
    +
    +

    Type declaration

    +
    +
  • Defined in src/pools/pool.ts:258
  • workerNodes: IWorkerNode<Worker, Data>[]
    @@ -290,20 +317,20 @@
    +
  • Defined in src/pools/pool.ts:219
  • @@ -320,72 +347,33 @@
  • setTasksQueueOptions
  • setWorkerChoiceStrategy
  • setWorkerChoiceStrategyOptions
  • +
  • start
  • workerNodes
  • +

    Generated using TypeDoc

    -
    \ No newline at end of file +
    \ No newline at end of file