X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=66c5140b59b8e081abe82742ca6ed282fc050389;hb=dbf662afd2c11c4d18c4e648f90d392528a715f8;hp=cc0d1a73d61e56e63dc26bdb6eac29147be1a482;hpb=010ae1ba98e5ab018fa09870982d511c9389b48b;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index cc0d1a73..66c5140b 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,13 +1,13 @@ -IPool | poolifier - v2.6.37
+IPool | poolifier - v2.7.0
-
+
  • The search index is not available
    • poolifier - v2.7.0 +
    @@ -46,44 +46,84 @@ +
  • Defined in src/pools/pool.ts:206
    • - +

    Properties

    -
    destroy +
    addTaskFunction +destroy emitter? enableTasksQueue execute +hasTaskFunction hasWorkerNodeBackPressure info -listTaskFunctions +listTaskFunctionNames +removeTaskFunction +setDefaultTaskFunction setTasksQueueOptions setWorkerChoiceStrategy setWorkerChoiceStrategyOptions +start workerNodes

    Properties

    +
    +

    Readonly addTaskFunction

    +
    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.

        +
    -

    Readonly destroy

    +

    Readonly destroy

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

    Type declaration

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

      • Terminates all workers in this pool.

        Returns Promise<void>

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

    • Optional Readonly emitter

    emitter?: PoolEmitter
    @@ -101,7 +141,7 @@
    +
  • Defined in src/pools/pool.ts:242

    • Readonly enableTasksQueue

    enableTasksQueue: ((enable, tasksQueueOptions?) => void)
    @@ -110,7 +150,7 @@
      • -
      • (enable, tasksQueueOptions?): void
        • +
      • (enable, tasksQueueOptions?): void

      • Enables/disables the worker node tasks queue in this pool.

        @@ -120,15 +160,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:329

    • Readonly execute

    execute: ((data?, name?, transferList?) => Promise<Response>)
    @@ -137,7 +179,7 @@

    Returns Promise<Response>

    Promise that will be fulfilled when the task is completed.

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

    Readonly hasTaskFunction

    +
    hasTaskFunction: ((name) => boolean)
    +
    +

    Type declaration

    +

    Readonly hasWorkerNodeBackPressure

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

    Returns boolean

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

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

    • Readonly info

    info: PoolInfo
    @@ -192,16 +263,16 @@
    -
    -

    Readonly listTaskFunctions

    -
    listTaskFunctions: (() => string[])
    +
  • Defined in src/pools/pool.ts:214
    • +
    +

    Readonly listTaskFunctionNames

    +
    listTaskFunctionNames: (() => string[])

    Type declaration

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

    Readonly removeTaskFunction

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

    Type declaration

    +
    +
    +

    Readonly setDefaultTaskFunction

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

    Type declaration

    +

    Readonly setTasksQueueOptions

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

    Returns void

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

    • Readonly setWorkerChoiceStrategy

    setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void)
    @@ -241,7 +363,7 @@

    Returns void

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

    • Readonly setWorkerChoiceStrategyOptions

    setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)
    @@ -268,7 +392,7 @@ +

    Returns void

    +
    +
    +

    Readonly start

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

    Type declaration

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

    • Readonly Internal workerNodes

    workerNodes: IWorkerNode<Worker, Data>[]
    @@ -290,103 +431,67 @@
    +
  • Defined in src/pools/pool.ts:220
    • -

    Settings

     +

    Settings

    Member Visibility

      -
      • -
      • -
      • -
    +
    • +
    • +
    • +

    • Theme

    On This Page
    -
    +

    Generated using TypeDoc

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