X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=1135bfdc7c48600d194d29e380410af18d594b98;hb=fb8fbcfd7983c1eadc39411c9b29054e6fa97d5b;hp=92f13dd905df1ab0c97e3351d6517be76ad1b2d0;hpb=de2e7182cca6b34b000a09bf6d0ddcff4757db3a;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 92f13dd9..1135bfdc 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,4 +1,4 @@ -IPool | poolifier - v2.6.25
+IPool | poolifier - v2.6.28
  • Preparing search index...
  • -
  • The search index is not available
poolifier - v2.6.25
+
  • The search index is not available
  • poolifier - v2.6.28
    @@ -46,7 +46,7 @@ +
  • Defined in src/pools/pool.ts:169
  • @@ -59,6 +59,7 @@ enableTasksQueue execute info +listTaskFunctions setTasksQueueOptions setWorkerChoiceStrategy setWorkerChoiceStrategyOptions @@ -81,23 +82,24 @@

    Returns Promise<void>

    +
  • Defined in src/pools/pool.ts:211
  • emitter?: PoolEmitter

    Emitter on which events can be listened to.

    Events that can currently be listened to:

      -
    • 'full': Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.
    • '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.
    • +
    • '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.
    • 'taskError': Emitted when an error occurs while executing a task.
    +
  • Defined in src/pools/pool.ts:194
  • enableTasksQueue: ((enable, tasksQueueOptions?) => void)
    @@ -126,7 +128,7 @@

    Returns void

    +
  • Defined in src/pools/pool.ts:242
  • execute: ((data?, name?, transferList?) => Promise<Response>)
    @@ -161,7 +163,7 @@
    +
  • Defined in src/pools/pool.ts:203
  • info: PoolInfo
    @@ -169,7 +171,24 @@
    +
  • Defined in src/pools/pool.ts:177
  • +
    + +
    listTaskFunctions: (() => string[])
    +
    +

    Type declaration

    +
      +
    • +
        +
      • (): string[]
      • +
      • +

        Lists the names of task function available in this pool.

        +
        +

        Returns string[]

        The names of task function available in this pool.

        + +
    setTasksQueueOptions: ((tasksQueueOptions) => void)
    @@ -178,7 +197,7 @@
    +
  • Defined in src/pools/pool.ts:251
  • setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void)
    @@ -202,7 +221,7 @@
    +
  • Defined in src/pools/pool.ts:224
  • setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)
    @@ -231,7 +250,7 @@
    +
  • Defined in src/pools/pool.ts:233
  • workerNodes: IWorkerNode<Worker, Data>[]
    @@ -254,7 +273,7 @@
    +
  • Defined in src/pools/pool.ts:181