X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=071c59d5926ddfbe3a763dd6300d28b8d70476e5;hb=94ab998f44abe7ed2184a0702c45621b06f5641f;hp=c7fe36db8141f5140f5e252b6f3fed5e2eb08794;hpb=0c1d2aee9268a3d1cad693d46d3ffe253e1f6a41;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index c7fe36db..071c59d5 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -6,7 +6,7 @@ poolifier +
  • The search index is not available
  • poolifier
    @@ -34,7 +34,7 @@ +
  • Defined in src/pools/pool.ts:66
  • @@ -42,43 +42,49 @@

    Properties

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

    Type declaration

    +
      +
    • +
        +
      • (): Promise<void>
      • +
      • +

        Shutdowns every current worker in this pool.

        +
        +

        Returns Promise<void>

    - +
    emitter?: PoolEmitter

    Emitter on which events can be listened to.

    Events that can currently be listened to:

      -
    • 'busy'
    • +
    • 'full': Emitted when the pool is dynamic and full.
    • +
    • 'busy': Emitted when the pool is busy.
    -
    -

    Methods

    -
    - -
      - -
    • -

      Shutdowns every current worker in this pool.

      -
      -

      Returns Promise<void>

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

      Type declaration

      +
        +
      • +
          +
        • (data: Data): Promise<Response>
        • Performs the task specified in the constructor with the data parameter.

          @@ -91,13 +97,18 @@
          data: Data

          The input for the specified task. This can only be serializable data.

      -

      Returns Promise<Response>

    -
    +
  • Defined in src/pools/pool.ts:82
  • +
    -
    +
  • Defined in src/pools/pool.ts:92
  • +
  • execute
  • +
  • setWorkerChoiceStrategy
  • Generated using TypeDoc

    \ No newline at end of file