X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=72dc6790e562e637da104b7607e8be4b32214c71;hb=c7e196baa67e4deb14377afbd9d6d5f655e5c384;hp=c6e2995e72f26d899d8bb6aaed60a5b8c82f28e3;hpb=8d1797ad15cb2d87ac3c9904ce6df3db45c0c742;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index c6e2995e..72dc6790 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -18,9 +18,9 @@

Contract definition for a poolifier pool.

-
+

Type Parameters

-
+
  • Defined in src/pools/pool.ts:119
  • @@ -54,7 +54,6 @@ emitter? enableTasksQueue execute -findFreeWorkerNodeKey setTasksQueueOptions setWorkerChoiceStrategy setWorkerChoiceStrategyOptions @@ -77,7 +76,7 @@

    Returns Promise<void>

    +
  • Defined in src/pools/pool.ts:153
  • emitter?: PoolEmitter
    @@ -89,7 +88,7 @@
    +
  • Defined in src/pools/pool.ts:142
  • enableTasksQueue: ((enable, tasksQueueOptions?) => void)
    @@ -115,7 +114,7 @@

    Returns void

    +
  • Defined in src/pools/pool.ts:178
  • execute: ((data?) => Promise<Response>)
    @@ -127,8 +126,6 @@
  • (data?): Promise<Response>
  • Executes the function specified in the worker constructor with the task data input parameter.

    - -

    Returns

    Promise that will be fulfilled when the task is completed.

    Parameters

    @@ -137,28 +134,10 @@
    Optional data: Data

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

  • -

    Returns Promise<Response>

    -
    - -
    findFreeWorkerNodeKey: (() => number)
    -
    -

    Type declaration

    -
    +
  • Defined in src/pools/pool.ts:149
  • setTasksQueueOptions: ((tasksQueueOptions) => void)
    @@ -167,7 +146,7 @@
    +
  • Defined in src/pools/pool.ts:187
  • setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void)
    @@ -189,7 +168,7 @@
    +
  • Defined in src/pools/pool.ts:160
  • setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)
    @@ -215,7 +194,7 @@
    +
  • Defined in src/pools/pool.ts:169
  • type: PoolType
    @@ -236,14 +215,14 @@

    If it is 'dynamic', it provides the max property.

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

    Pool worker nodes.

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