X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=80ced8c2e418c996ae119c266c59b6bcc6f15f90;hb=ae55bb0ecb73cd5cf8d4d5bc62a145e0476aec38;hp=78acb1c92fad7956b4ad292dbf6c135d5b10015a;hpb=493f77bdef6d66ad2fcb72b405c805274b24f3db;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 78acb1c9..80ced8c2 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -17,22 +17,26 @@
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.
+Shutdowns 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.'error'
: Emitted when an uncaught error occurs.'taskError'
: Emitted when an error occurs while executing a task.Whether to enable or disable the worker tasks queue.
-Optional
tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
-Optional
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
infoPool information.
+The worker tasks queue options.
-The worker choice strategy.
-Optional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
-The worker choice strategy options.
-Readonly
sizePool maximum size.
-Readonly
typePool type.
-If it is 'dynamic'
, it provides the max
property.
Readonly
workerReadonly
workerPool worker nodes.
-Generated using TypeDoc
Contract definition for a poolifier pool.
-