X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=7911f61f194612f589612577ae878dc8cc2912f9;hb=177be4a662e85919499d34984db6c77c6e5da5f6;hp=d8d8c10381a8c7c6e11f3535a1b82fe231760c32;hpb=301c53e7ae6cf1120298ea10868a9091904c01a2;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index d8d8c103..9cb858c6 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,84 +1,203 @@ -IPool | poolifier
+IPool | poolifier - v2.6.16
-
+
  • The search index is not available
    • poolifier - v2.6.16 +
    -
    +
    -

    Interface IPool<Data, Response>

    +

    Interface IPool<Worker, Data, Response>

    Contract definition for a poolifier pool.

    -
    -
    +
    +
    +

    Type Parameters

    -
    +

    Response = unknown

    +

    Type of execution response. This can only be structured-cloneable data.

    +
    +

    Hierarchy

    -

    Methods

    -
    destroy -execute -setWorkerChoiceStrategy +

    Properties

    +
    destroy +emitter? +enableTasksQueue +execute +info +setTasksQueueOptions +setWorkerChoiceStrategy +setWorkerChoiceStrategyOptions +workerNodes
    -

    Methods

    -
    -

    destroy

    -
      - +

      Properties

      +
      +

      Readonly destroy

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

      Type declaration

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

          Terminates every current worker in this pool.

          +
          +

          Returns Promise<void>

          +
      +
      +

      Optional Readonly emitter

      +
      emitter?: PoolEmitter
      +

      Emitter on which events can be listened to.

      +

      Events that can currently be listened to:

      +
        +
      • 'full': Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.
        • +
      • 'ready': Emitted when the number of workers created in the pool has reached the minimum size expected and are ready.
        • +
      • 'busy': Emitted when the number of workers created in the pool has reached the maximum size expected and are executing at least one task.
        • +
      • 'error': Emitted when an uncaught error occurs.
        • +
      • 'taskError': Emitted when an error occurs while executing a task.
        • +
      +
      +
      +
      +

      Readonly enableTasksQueue

      +
      enableTasksQueue: ((enable, tasksQueueOptions?) => void)
      +
      +

      Type declaration

      +
        +
      • +
          +
        • (enable, tasksQueueOptions?): void
        • -

          Shutdowns every current worker in this pool.

          +

          Enables/disables the worker tasks queue in this pool.

          -

          Returns Promise<void>

    -
    -

    execute

    -
    +
    +

    Readonly execute

    +
    execute: ((data?, name?) => Promise<Response>)
    +
    +

    Type declaration

    +
      +
    • +
        +
      • (data?, name?): Promise<Response>
      • -

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

        +

        Executes the specified function in the worker constructor with the task data input parameter.

        +
        +
        +

        Parameters

        +
          +
        • +
          Optional data: Data
          +

          The task input data for the specified worker function. This can only be structured-cloneable data.

          +
          +
          • +
        • +
          Optional name: string
          +

          The name of the worker function to execute. If not specified, the default worker function will be executed.

          +
          +
        +

        Returns Promise<Response>

        Promise that will be fulfilled when the task is completed.

        -

        Returns

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

        +
    +
    +

    Readonly info

    +
    info: PoolInfo
    +

    Pool information.

    +
    +
    +
    +

    Readonly setTasksQueueOptions

    +
    setTasksQueueOptions: ((tasksQueueOptions) => void)
    +
    +

    Type declaration

    +
      +
    • +
        +
      • (tasksQueueOptions): void
        • +
      • +

        Sets the worker tasks queue options in this pool.

        Parameters

        • -
          data: Data
          -

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

          -
        -

        Returns Promise<Response>

    +

    Returns void

    +
    -
    -

    setWorkerChoiceStrategy

    -
    +
    +

    Readonly setWorkerChoiceStrategy

    +
    setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void)
    +
    +

    Type declaration

    +
    -

    Returns void

    -
    +
  • Defined in src/pools/pool.ts:210
    • +
    +

    Readonly setWorkerChoiceStrategyOptions

    +
    setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)
    +
    +

    Type declaration

    +
      +
    • +
        +
      • (workerChoiceStrategyOptions): void
        • +
      • +

        Sets the worker choice strategy options in this pool.

        +
        +
        +

        Parameters

        +
        +

        Returns void

        +
    +
    +

    Readonly workerNodes

    +
    workerNodes: IWorkerNode<Worker, Data>[]
    +

    Pool worker nodes.

    +
    +
    +
    +
    -

    Settings

     +

    Settings

    Member Visibility

    @@ -105,21 +264,82 @@
    • -

    Theme

    -
    +
    +

    On This Page
    - -
    +
  • destroy
    • +
  • emitter
    • +
  • enableTasksQueue
    • +
  • execute
    • +
  • info
    • +
  • setTasksQueueOptions
    • +
  • setWorkerChoiceStrategy
    • +
  • setWorkerChoiceStrategyOptions
    • +
  • workerNodes
    • +
    +
    +

    Generated using TypeDoc

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