X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Finterfaces%2FIPool.html;h=cd3fa5d37d13bf47893cf22bf8fdd49b14220888;hb=a464a1f80f2239f7c8faa2998b0ba814ac7bddc6;hp=0c22722b96bf9a41becf44dc0b8b7c85a7cdf5be;hpb=8d98e603c79d8d00b2b6a33e5f732701a7466234;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 0c22722b..cd3fa5d3 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,4 +1,4 @@ -
Type of worker which manages this pool.
-Type of data sent to the worker. This can only be serializable data.
-Type of data sent to the worker. This can only be structured-cloneable data.
+Type of execution response. This can only be serializable data.
-Type of execution response. This can only be structured-cloneable data.
+Readonly
destroyShutdowns every current worker in this pool.
+Terminates every current worker in this pool.
Optional
Readonly
emitterOptional
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
enableWhether to enable or disable the worker tasks queue.
-Optional
tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
-Readonly
executeOptional
data: DataThe task input data for the specified worker function. This can only be serializable data.
-The task input data for the specified worker 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.
-Promise that will be fulfilled when the task is completed.
-Readonly
infoReadonly
infoPool information.
-Readonly
setThe worker tasks queue options.
-Readonly
setThe worker choice strategy.
-Optional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
-Readonly
setThe worker choice strategy options.
-Readonly
workerReadonly
workerPool worker nodes.
-Generated using TypeDoc
Contract definition for a poolifier pool.
-