IPool | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=92f13dd905df1ab0c97e3351d6517be76ad1b2d0;hb=1d9f69fa27366fd18f2600beeee89187306df22a;hp=d78b44db3e80f24b38c5efee7238536b665401da;hpb=36df5bd40369d98d6ccb60400e66dce1aa980d54;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index d78b44db..92f13dd9 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,4 +1,4 @@ -IPool | poolifier - v2.6.15

+IPool | poolifier - v2.6.25

@@ -46,7 +46,7 @@

AbstractPool

Defined in src/pools/pool.ts:168

@@ -76,12 +76,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 +97,7 @@

Defined in src/pools/pool.ts:192

`Readonly` enableTasksQueue

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

@@ -126,16 +126,16 @@

Returns void

Defined in src/pools/pool.ts:234

`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 +144,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.