X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=73ce654de454741de3d96fef17df859fbac26aab;hb=6cbae9fd636239a8a1c668fd1f70c31093c5d6e2;hp=fdaa85b21e5b0882c478d62dad99358cfd3c0acf;hpb=030eb5a38e62c6e381961644eab2ddac9a027aea;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index fdaa85b2..73ce654d 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,4 +1,4 @@ -
Readonly
destroyOptional
Readonly
emitterEmitter on which events can be listened to.
Events that can currently be listened to:
'full'
: Emitted when the pool is dynamic and full.'busy'
: Emitted when the pool is busy.'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
enableReadonly
executeOptional
data: DataThe task input data for the specified worker function. This can only be structured-cloneable data.
+The task input data for the specified task function. This can only be structured-cloneable data.
Optional
name: stringThe name of the worker function to execute. If not specified, the default worker function will be executed.
+The name of the task function to execute. If not specified, the default task function will be executed.
Promise that will be fulfilled when the task is completed.
Readonly
infoReadonly
setReadonly
setReadonly
setReadonly
workerPool worker nodes.
Generated using TypeDoc
Terminate every current worker in this pool.
+Terminates all workers in this pool.
Returns Promise<void>