X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Finterfaces%2FIPool.html;h=b3ec1fcd098b9a7c331027fd555c2115cbef04e9;hb=15bb637a91abd156aae586ce14c663101a8c6697;hp=68183a8fc4ca9065feb7818590e33e833ad4d03b;hpb=e7339cfd46bfe4600187ae2c6bd6c9e7f63e7052;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 68183a8f..b3ec1fcd 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -31,7 +31,7 @@
  • Response = unknown

    -

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

    +

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

  • Hierarchy

    @@ -42,7 +42,7 @@
    +
  • Defined in src/pools/pool.ts:119
  • @@ -50,28 +50,21 @@

    Properties

    -
    - -
    busy: boolean
    -

    Whether the pool is busy or not.

    -

    The pool busyness boolean status.

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

    Type declaration

    @@ -84,7 +77,7 @@

    Returns Promise<void>

    +
  • Defined in src/pools/pool.ts:163
  • emitter?: PoolEmitter
    @@ -96,31 +89,57 @@
    +
  • Defined in src/pools/pool.ts:142
  • +
    + +
    enableTasksQueue: ((enable: boolean, tasksQueueOptions?: TasksQueueOptions) => void)
    +
    +

    Type declaration

    +
    -
    execute: ((data: Data) => Promise<Response>)
    +
    execute: ((data?: Data) => Promise<Response>)

    Type declaration

    +
  • Defined in src/pools/pool.ts:159
  • findFreeWorkerNodeKey: (() => number)
    @@ -129,7 +148,7 @@
    -
    - -
    full: boolean
    -

    Whether the pool is full or not.

    -

    The pool filling boolean status.

    -
    +
    + +
    setTasksQueueOptions: ((tasksQueueOptions: TasksQueueOptions) => void)
    +
    +

    Type declaration

    +
    +
  • Defined in src/pools/pool.ts:197
  • -
    setWorkerChoiceStrategy: ((workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN") => void)
    +
    setWorkerChoiceStrategy: ((workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN", workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions) => void)

    Type declaration

    +

    Returns void

    +
    + +
    setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions: WorkerChoiceStrategyOptions) => void)
    +
    +

    Type declaration

    +
    +
  • Defined in src/pools/pool.ts:179
  • type: PoolType
    @@ -177,14 +236,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