X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=379d6c3b358825df2004d517c4ea64c9ed5d3ffc;hb=842d8918a19fc2720d4436789a2e373bc623452e;hp=aa5596f711a877e710877db71812c816ad591700;hpb=42db2d3372ac49ab00dd1889378238b7a78ac4ce;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index aa5596f7..379d6c3b 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -14,7 +14,7 @@ -

Interface IPool<Data, Response>

+

Interface IPool<Worker, Data, Response>

Contract definition for a poolifier pool.

@@ -22,6 +22,10 @@

Type Parameters

+
+

Implemented by

+
+
  • Defined in src/pools/pool.ts:117
  • @@ -42,15 +50,28 @@

    Properties

    +
    + +
    busy: boolean
    +

    Whether the pool is busy or not.

    +

    The pool busyness boolean status.

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

    Type declaration

    @@ -63,7 +84,7 @@

    Returns Promise<void>

    +
  • Defined in src/pools/pool.ts:173
  • emitter?: PoolEmitter
    @@ -75,7 +96,7 @@
    +
  • Defined in src/pools/pool.ts:140
  • execute: ((data: Data) => Promise<Response>)
    @@ -99,7 +120,34 @@

    Returns Promise<Response>

    +
  • Defined in src/pools/pool.ts:169
  • +
    + +
    findFreeWorkerNodeKey: (() => number)
    +
    +

    Type declaration

    +
    +
    + +
    full: boolean
    +

    Whether the pool is full or not.

    +

    The pool filling boolean status.

    +
    setWorkerChoiceStrategy: ((workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN") => void)
    @@ -108,7 +156,7 @@
    +
  • Defined in src/pools/pool.ts:179
  • +
    + +
    type: PoolType
    +

    Pool type.

    +

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

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

    Pool worker nodes.

    +