X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=57e9ccccfead65be11efd5eb325a391180142862;hb=0e16e60a89029abe61cda7ba293c036298cced05;hp=cd3fa5d37d13bf47893cf22bf8fdd49b14220888;hpb=79f98bd9040049eec047b50d2cbd0878fdc9e6f1;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index cd3fa5d3..57e9cccc 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,4 +1,4 @@ -IPool | poolifier - v2.6.15
+IPool | poolifier - v2.6.26
  • Preparing search index...
    • -
  • The search index is not available
poolifier - v2.6.15
+
  • The search index is not available
    • poolifier - v2.6.26
    @@ -46,7 +46,7 @@ +
  • Defined in src/pools/pool.ts:168
    • @@ -59,6 +59,7 @@ enableTasksQueue execute info +listTaskFunctions setTasksQueueOptions setWorkerChoiceStrategy setWorkerChoiceStrategyOptions @@ -76,12 +77,12 @@
    • (): Promise<void>
    • -

      Terminates every current worker in this pool.

      +

      Terminates all workers in this pool.

      Returns Promise<void>

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

    • Optional Readonly emitter

    emitter?: PoolEmitter
    @@ -97,7 +98,7 @@
    +
  • Defined in src/pools/pool.ts:192

    • Readonly enableTasksQueue

    enableTasksQueue: ((enable, tasksQueueOptions?) => void)
    @@ -126,16 +127,16 @@

    Returns void

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

    • Readonly execute

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

    Type declaration

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

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

        @@ -144,19 +145,24 @@
        • Optional data: Data
          -

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

          +

          The optional task input data for the specified task 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.

          +

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

          +
          +
          • +
        • +
          Optional transferList: TransferListItem[]
          +

          An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the pool's worker_threads worker and they should not be used in the main thread afterwards.

    Returns Promise<Response>

    Promise that will be fulfilled when the task is completed.

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

    • Readonly info

    info: PoolInfo
    @@ -164,7 +170,24 @@
    +
  • Defined in src/pools/pool.ts:176
    • +
    +

    Readonly listTaskFunctions

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

    Type declaration

    +
      +
    • +
        +
      • (): string[]
        • +
      • +

        Lists the names of task function available in this pool.

        +
        +

        Returns string[]

        The names of task function available in this pool.

        + +

    Readonly setTasksQueueOptions

    setTasksQueueOptions: ((tasksQueueOptions) => void)
    @@ -173,7 +196,7 @@
    +
  • Defined in src/pools/pool.ts:249

    • Readonly setWorkerChoiceStrategy

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

    • Readonly setWorkerChoiceStrategyOptions

    setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)
    @@ -226,7 +249,7 @@
    +
  • Defined in src/pools/pool.ts:231

    • Readonly workerNodes

    workerNodes: IWorkerNode<Worker, Data>[]
    @@ -249,7 +272,7 @@
    +
  • Defined in src/pools/pool.ts:180
    • @@ -274,12 +297,13 @@
  • enableTasksQueue
  • execute
  • info
    • +
  • listTaskFunctions
  • setTasksQueueOptions
  • setWorkerChoiceStrategy
  • setWorkerChoiceStrategyOptions
  • workerNodes
    • -