X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=7ea1c393837e025c202e4411c6a7ff46a9b4ef0b;hb=a6b5c73ccccb3ef0ccc24ad462182e3cacee77b4;hp=7a5959976b8611044d87fe024cdeb1cf1ef0288c;hpb=004a8816ae9b52388de246a9c7a5184a73915ad6;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 7a595997..7ea1c393 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,4 +1,4 @@ -IPool | poolifier
+IPool | poolifier - v2.6.9
  • Preparing search index...
    • -
  • The search index is not available
poolifier
+
  • The search index is not available
    • poolifier - v2.6.9
    @@ -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:164
    • @@ -67,7 +67,7 @@

    Properties

    -

    destroy

    +

    Readonly destroy

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

    Type declaration

    @@ -76,12 +76,12 @@
    • (): 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:199

    • Optional Readonly emitter

    emitter?: PoolEmitter
    @@ -96,9 +96,9 @@
    +
  • Defined in src/pools/pool.ts:187
    • -

    enableTasksQueue

    +

    Readonly enableTasksQueue

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

    Type declaration

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

    Returns void

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

    execute

    +

    Readonly execute

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

    Type declaration

    @@ -143,7 +143,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 +155,7 @@
    +
  • Defined in src/pools/pool.ts:195

    • Readonly info

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

    setTasksQueueOptions

    +

    Readonly setTasksQueueOptions

    setTasksQueueOptions: ((tasksQueueOptions) => void)

    Type declaration

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

    Returns void

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

    setWorkerChoiceStrategy

    +

    Readonly setWorkerChoiceStrategy

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

    Type declaration

    @@ -204,7 +204,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 +216,9 @@

      Returns void

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

    setWorkerChoiceStrategyOptions

    +

    Readonly setWorkerChoiceStrategyOptions

    setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)

    Type declaration

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

    Returns void

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

    • Readonly workerNodes

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

    Pool worker nodes.

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

    • Generated using TypeDoc

    \ No newline at end of file