X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=72dc6790e562e637da104b7607e8be4b32214c71;hb=c7e196baa67e4deb14377afbd9d6d5f655e5c384;hp=7439713da5a26089e0a247f01165c0089991309a;hpb=0163b91de7e67e0c3b29b542bd2d47cce655b262;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 7439713d..72dc6790 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 response of execution. This can only be serializable data.
+Type of execution response. This can only be serializable data.
Optional
Readonly
emitterShutdowns every current worker in this pool.
+Optional
Readonly
emitterEmitter on which events can be listened to.
Events that can currently be listened to:
'busy'
'full'
: Emitted when the pool is dynamic and full.'busy'
: Emitted when the pool is busy.Shutdowns every current worker in this pool.
+Enables/disables the worker tasks queue in this pool.
Whether to enable or disable the worker tasks queue.
+Optional
tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
+Performs the task specified in the constructor with the data parameter.
- -Promise that will be resolved when the task is successfully completed.
+Executes the function specified in the worker constructor with the task data input parameter.
The input for the specified task. This can only be serializable data.
+Optional
data: DataThe task input data for the specified worker function. This can only be serializable data.
Promise that will be fulfilled when the task is completed.
+Sets the worker tasks queue options in this pool.
+The worker tasks queue options.
+Sets the worker choice strategy in this pool.
The worker choice strategy.
+Optional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
+Sets the worker choice strategy options in this pool.
+The worker choice strategy options.
Readonly
typePool type.
+If it is 'dynamic'
, it provides the max
property.
Readonly
workerPool worker nodes.
+Generated using TypeDoc
Contract definition for a poolifier pool.