X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=docs%2Finterfaces%2FIPool.html;h=001e5789d57f65a4b14c07c8b9715bb446760017;hb=3aaed019abde0022e986c1db05db9d5d7bc76594;hp=488af2256da5e6129e0d55a34e7cda2bc7b4bea0;hpb=248bc34b348a7d8d2b90eecff49d60a3b465da9e;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 488af225..001e5789 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,11 +1,13 @@ IPool | poolifier
-
+
  • The search index is not available
    • poolifier +
    @@ -32,36 +34,53 @@
    • IPool
    +
  • Defined in src/pools/pool.ts:53
    • +

    Properties

    +
    emitter? +
    +

    Methods

    destroy execute setWorkerChoiceStrategy
    +

    Properties

    +
    +

    Optional Readonly emitter

    +
    emitter?: PoolEmitter
    +

    Emitter on which events can be listened to.

    +

    Events that can currently be listened to:

    +
      +
    • 'busy'
      • +
    +
    +

    Methods

    -

    destroy

    +

    destroy

    • -

      Shut down every current worker in this pool.

      +

      Shutdowns every current worker in this pool.

      Returns Promise<void>

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

    • execute

    • -

      Perform the task specified in the constructor with the data parameter.

      +

      Performs the task specified in the constructor with the data parameter.

      Returns

      Promise that will be resolved when the task is successfully completed.

      @@ -74,24 +93,24 @@

    Returns Promise<Response>

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

    • setWorkerChoiceStrategy

      - +
    • -

      Set the worker choice strategy in this pool.

      +

      Sets the worker choice strategy in this pool.

      Parameters

      • -
        workerChoiceStrategy: "ROUND_ROBIN" | "LESS_RECENTLY_USED"
        +
        workerChoiceStrategy: "ROUND_ROBIN" | "LESS_RECENTLY_USED" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"

        The worker choice strategy.

      Returns void

    +
  • Defined in src/pools/pool.ts:78
    • @@ -117,6 +136,7 @@