X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=ff7878f0b7e8b6b16d6551605d12b7ca51350006;hb=da66e34cda2cbcb3a94865d24696c668f50a1437;hp=49561424d415e22520b0d7118a81b4e3afe65aa4;hpb=a4ba0bba85ba79e61e4095edccbde9a6ee2fc08a;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 49561424..ff7878f0 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,13 +1,13 @@ -IPool | poolifier - v2.6.32
+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 +
    destroy emitter? enableTasksQueue execute @@ -64,12 +64,13 @@ setTasksQueueOptions setWorkerChoiceStrategy setWorkerChoiceStrategyOptions +start workerNodes

    Properties

    -

    Readonly destroy

    +

    Readonly destroy

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

    Type declaration

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

    Returns Promise<void>

    +
  • Defined in src/pools/pool.ts:262

    • Optional Readonly emitter

    emitter?: PoolEmitter
    @@ -91,9 +92,9 @@

    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.
      • +
    • 'destroy': Emitted when the pool is destroyed.
    • 'error': Emitted when an uncaught error occurs.
    • 'taskError': Emitted when an error occurs while executing a task.
    • 'backPressure': Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size >= maximum queue size).
      • @@ -101,7 +102,7 @@
    +
  • Defined in src/pools/pool.ts:241

    • Readonly enableTasksQueue

    enableTasksQueue: ((enable, tasksQueueOptions?) => void)
    @@ -130,7 +131,7 @@

    Returns void

    +
  • Defined in src/pools/pool.ts:293

    • Readonly execute

    execute: ((data?, name?, transferList?) => Promise<Response>)
    @@ -165,7 +166,7 @@
    +
  • Defined in src/pools/pool.ts:250

    • Readonly hasWorkerNodeBackPressure

    hasWorkerNodeBackPressure: ((workerNodeKey) => boolean)
    @@ -190,7 +191,7 @@
    +
  • Defined in src/pools/pool.ts:227

    • Readonly info

    info: PoolInfo
    @@ -198,7 +199,7 @@
    +
  • Defined in src/pools/pool.ts:213

    • Readonly listTaskFunctions

    listTaskFunctions: (() => string[])
    @@ -215,7 +216,7 @@
    +
  • Defined in src/pools/pool.ts:268

    • Readonly setTasksQueueOptions

    setTasksQueueOptions: ((tasksQueueOptions) => void)
    @@ -239,7 +240,7 @@

    Returns void

    +
  • Defined in src/pools/pool.ts:302

    • Readonly setWorkerChoiceStrategy

    setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void)
    @@ -268,7 +269,7 @@

    Returns void

    +
  • Defined in src/pools/pool.ts:275

    • Readonly setWorkerChoiceStrategyOptions

    setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)
    @@ -292,7 +293,23 @@

    Returns void

    +
  • Defined in src/pools/pool.ts:284
    • +
    +

    Readonly start

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

    Type declaration

    +

    Readonly Internal workerNodes

    workerNodes: IWorkerNode<Worker, Data>[]
    @@ -300,20 +317,20 @@
    +
  • Defined in src/pools/pool.ts:219
    • -

    Settings

     +

    Settings

    Member Visibility

      -
      • -
      • -
      • -
    +
    • +
    • +
    • +

    • Theme

    @@ -330,70 +347,33 @@
  • setTasksQueueOptions
  • setWorkerChoiceStrategy
  • setWorkerChoiceStrategyOptions
    • +
  • start
  • workerNodes
    • -
    +
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    +
    \ No newline at end of file