X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=fb4b28aab80a5f00c3b6ccde3abf509dfb869c4b;hb=76b46937556ea55049d5c413aa0a77d0c7f47f48;hp=740e3b8eb00235c2d5f748a35952d59f3e1aafe5;hpb=71056a0ac555e096c1428d6341ef45c7980a6332;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 740e3b8e..fb4b28aa 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,4 +1,4 @@ -IPool | poolifier
+IPool | poolifier - v2.6.19
  • Preparing search index...
    • -
  • The search index is not available
poolifier
+
  • The search index is not available
    • poolifier - v2.6.19
    @@ -29,12 +29,12 @@

  • Data = unknown

    -

    Type of data sent to the worker. This can only be serializable data.

    +

    Type of data sent to the worker. This can only be structured-cloneable data.

  • Response = unknown

    -

    Type of execution response. This can only be serializable data.

    +

    Type of execution response. This can only be structured-cloneable data.

    • @@ -46,7 +46,7 @@
    +
  • Defined in src/pools/pool.ts:167
    • @@ -67,7 +67,7 @@

    Properties

    -

    destroy

    +

    Readonly destroy

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

    Type declaration

    @@ -76,29 +76,30 @@
    • (): Promise<void>
    • -

      Shutdowns every current worker in this pool.

      +

      Terminates every current worker in this pool.

      Returns Promise<void>

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

    • Optional Readonly emitter

    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

    +

    Readonly enableTasksQueue

    enableTasksQueue: ((enable, tasksQueueOptions?) => void)

    Type declaration

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

    Returns void

    +
  • Defined in src/pools/pool.ts:228
    • -

    execute

    +

    Readonly execute

    execute: ((data?, name?) => Promise<Response>)

    Type declaration

    @@ -143,7 +144,7 @@
    • Optional data: Data
      -

      The task input data for the specified worker function. This can only be serializable data.

      +

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

    • @@ -155,7 +156,7 @@
    +
  • Defined in src/pools/pool.ts:199

    • Readonly info

    info: PoolInfo
    @@ -163,9 +164,9 @@
    +
  • Defined in src/pools/pool.ts:175
    • -

    setTasksQueueOptions

    +

    Readonly setTasksQueueOptions

    setTasksQueueOptions: ((tasksQueueOptions) => void)

    Type declaration

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

    Returns void

    +
  • Defined in src/pools/pool.ts:237
    • -

    setWorkerChoiceStrategy

    +

    Readonly setWorkerChoiceStrategy

    setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void)

    Type declaration

    @@ -204,7 +205,7 @@

    Parameters

    • -
      workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
      +
      workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"

      The worker choice strategy.

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

      Returns void

    +
  • Defined in src/pools/pool.ts:210
    • -

    setWorkerChoiceStrategyOptions

    +

    Readonly setWorkerChoiceStrategyOptions

    setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)

    Type declaration

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

    Returns void

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

    • Readonly workerNodes

    -
    workerNodes: WorkerNode<Worker, Data>[]
    +
    workerNodes: IWorkerNode<Worker, Data>[]

    Pool worker nodes.

    +
  • Defined in src/pools/pool.ts:179
    • @@ -278,7 +279,7 @@
  • setWorkerChoiceStrategyOptions
  • workerNodes
    • -
    +
  • WorkerTypes
    • +
  • availableParallelism

    • Generated using TypeDoc

    \ No newline at end of file