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

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 @@ -65,7 +64,7 @@

    Properties

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

    Type declaration

      @@ -77,10 +76,10 @@

    Returns Promise<void>

    +
  • Defined in src/pools/pool.ts:153
  • -
    emitter?: PoolEmitter
    +
    emitter?: PoolEmitter

    Emitter on which events can be listened to.

    Events that can currently be listened to:

      @@ -89,10 +88,10 @@
    +
  • Defined in src/pools/pool.ts:142
  • -
    enableTasksQueue: ((enable, tasksQueueOptions?) => void)
    +
    enableTasksQueue: ((enable, tasksQueueOptions?) => void)

    Type declaration

      @@ -110,15 +109,15 @@

      Whether to enable or disable the worker tasks queue.

    • -
      Optional tasksQueueOptions: TasksQueueOptions
      +
      Optional tasksQueueOptions: TasksQueueOptions

      The worker tasks queue options.

    Returns void

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

    Type declaration

    -

    Returns Promise<Response>

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

    Type declaration

    -
    +
  • Defined in src/pools/pool.ts:149
  • -
    setTasksQueueOptions: ((tasksQueueOptions) => void)
    +
    setTasksQueueOptions: ((tasksQueueOptions) => void)

    Type declaration

    Returns void

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

    Type declaration

    Returns void

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

    Type declaration

    Returns void

    +
  • Defined in src/pools/pool.ts:169
  • -
    type: PoolType
    +
    type: PoolType

    Pool type.

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

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

    Pool worker nodes.

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