X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=b64725e9908f76f69b5b40cc232538def3381e9d;hb=71d327d5587f0ce2b746ba33ec0cfbb3a0dc5d1b;hp=089d3914170dc88a6b071f5e1a68bf46ecdde8cd;hpb=2041f3d8b2564bfab8e30db6a87dba283219ca86;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 089d3914..b64725e9 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,13 +1,13 @@ -IPool | poolifier - v2.6.40
+IPool | poolifier - v2.7.4
-
+
  • The search index is not available
  • poolifier - v2.7.4 +
    @@ -46,48 +46,89 @@ +
  • Defined in src/pools/pool.ts:201
  • - +

    Properties

    +
    + +
    addTaskFunction: ((name, fn) => Promise<boolean>)
    +
    +

    Type declaration

    +
      +
    • +
        +
      • (name, fn): Promise<boolean>
      • +
      • +

        Adds a task function to this pool. +If a task function with the same name already exists, it will be overwritten.

        +
        +
        +

        Parameters

        +
          +
        • +
          name: string
          +

          The name of the task function.

          +
          +
        • +
        • +
          fn: TaskFunction<Data, Response>
          +

          The task function.

          +
          +
        +

        Returns Promise<boolean>

        true if the task function was added, false otherwise.

        + +
        +

        Throws

        https://nodejs.org/api/errors.html#class-typeerror If the name parameter is not a string or an empty string.

        + +

        Throws

        https://nodejs.org/api/errors.html#class-typeerror If the fn parameter is not a function.

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

    Type declaration

      • -
      • (): Promise<void>
      • +
      • (): Promise<void>
      • Terminates all workers in this pool.

        Returns Promise<void>

    +
  • Defined in src/pools/pool.ts:259
  • -
    emitter?: PoolEmitter
    -

    Emitter on which events can be listened to.

    +
    emitter?: __module | EventEmitterAsyncResource
    +

    Event emitter integrated with async resource on which events can be listened to. +The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool.

    Events that can currently be listened to:

    • 'ready': Emitted when the number of workers created in the pool has reached the minimum size expected and are ready.
    • @@ -101,7 +142,7 @@
    +
  • Defined in src/pools/pool.ts:238
  • enableTasksQueue: ((enable, tasksQueueOptions?) => void)
    @@ -110,7 +151,7 @@
      • -
      • (enable, tasksQueueOptions?): void
      • +
      • (enable, tasksQueueOptions?): void
      • Enables/disables the worker node tasks queue in this pool.

        @@ -120,15 +161,17 @@
      • enable: boolean

        Whether to enable or disable the worker node tasks queue.

        -
      • +
    +
  • Optional tasksQueueOptions: TasksQueueOptions

    The worker node tasks queue options.

    -
    Optional
  • +
    +

    Returns void

    +
  • Defined in src/pools/pool.ts:325
  • execute: ((data?, name?, transferList?) => Promise<Response>)
    @@ -137,7 +180,7 @@

    Returns Promise<Response>

    Promise that will be fulfilled when the task is completed.

    +
  • Defined in src/pools/pool.ts:247
  • +
    + +
    hasTaskFunction: ((name) => boolean)
    +
    +

    Type declaration

    +
    hasWorkerNodeBackPressure: ((workerNodeKey) => boolean)
    @@ -169,7 +240,7 @@

    Returns boolean

    true if the worker node has back pressure, false otherwise.

    +
  • Defined in src/pools/pool.ts:223
  • info: PoolInfo
    @@ -192,16 +264,16 @@
    -
    - -
    listTaskFunctions: (() => string[])
    +
  • Defined in src/pools/pool.ts:209
  • +
    + +
    listTaskFunctionNames: (() => string[])

    Type declaration

    +
  • Defined in src/pools/pool.ts:293
  • +
    + +
    removeTaskFunction: ((name) => Promise<boolean>)
    +
    +

    Type declaration

    +
    +
    + +
    setDefaultTaskFunction: ((name) => Promise<boolean>)
    +
    +

    Type declaration

    +
    setTasksQueueOptions: ((tasksQueueOptions) => void)
    @@ -218,7 +340,7 @@

    Returns void

    +
  • Defined in src/pools/pool.ts:334
  • setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void)
    @@ -241,7 +364,7 @@

    Returns void

    +
  • Defined in src/pools/pool.ts:307
  • setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)
    @@ -268,7 +393,7 @@ +

    Returns void

    +
    +
    + +
    start: (() => void)
    +
    +

    Type declaration

    +
    +
  • Defined in src/pools/pool.ts:255
  • workerNodes: IWorkerNode<Worker, Data>[]
    @@ -290,103 +432,67 @@
    +
  • Defined in src/pools/pool.ts:215
  • On This Page

    +

    Generated using TypeDoc

    -
    \ No newline at end of file +
    \ No newline at end of file