X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=3e933bc22f003c864124afcedfd9dcb056d80b3c;hb=a8884ffdad6658f854f4048d768f7e56cf8d5032;hp=ab6163b1b8706be6af794872a3c8e1c695a049ab;hpb=b142df6d1278e9d0b6c4c7226bf3dae36c486410;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index ab6163b1..3e933bc2 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 @@