X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=9cb858c67b6600f7f02c6b37b26f219855cac52a;hb=177be4a662e85919499d34984db6c77c6e5da5f6;hp=21b995490a430565931a6b2ac6c4218ea3d4d361;hpb=2624da4d8f724e8bc0b655cddfc6ba5ae9a4d053;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 21b99549..9cb858c6 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,4 +1,4 @@ -IPool | poolifier
+IPool | poolifier - v2.6.16
  • Preparing search index...
  • -
  • The search index is not available
poolifier
+
  • The search index is not available
  • poolifier - v2.6.16
    @@ -46,7 +46,7 @@ +
  • Defined in src/pools/pool.ts:167
  • @@ -67,7 +67,7 @@

    Properties

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

    Type declaration

    @@ -81,24 +81,25 @@

    Returns Promise<void>

    +
  • Defined in src/pools/pool.ts:203
  • 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 full.
    • -
    • 'busy': Emitted when the pool is busy.
    • +
    • '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.
    • 'error': Emitted when an uncaught error occurs.
    • 'taskError': Emitted when an error occurs while executing a task.
    +
  • Defined in src/pools/pool.ts:191
  • - +
    enableTasksQueue: ((enable, tasksQueueOptions?) => void)

    Type declaration

    @@ -125,9 +126,9 @@

    Returns void

    +
  • Defined in src/pools/pool.ts:228
  • - +
    execute: ((data?, name?) => Promise<Response>)

    Type declaration

    @@ -155,7 +156,7 @@
    +
  • Defined in src/pools/pool.ts:199
  • info: PoolInfo
    @@ -163,9 +164,9 @@
    +
  • Defined in src/pools/pool.ts:175
  • - +
    setTasksQueueOptions: ((tasksQueueOptions) => void)

    Type declaration

    @@ -187,9 +188,9 @@

    Returns void

    +
  • Defined in src/pools/pool.ts:237
  • - +
    setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void)

    Type declaration

    @@ -216,9 +217,9 @@

    Returns void

    +
  • Defined in src/pools/pool.ts:210
  • - +
    setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)

    Type declaration

    @@ -240,15 +241,15 @@

    Returns void

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

    Pool worker nodes.

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