X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=9207f5005de2714305243506df84e80215bc7963;hb=e8b3a5abad7d3ae4fa836ab0b76d54c1efd146e9;hp=e663f0b86dabc2f4f001270c706004c10dd7bad5;hpb=a2742ce794032ee57b3ec1203c500b1aecca34f0;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index e663f0b8..9207f500 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 execution response. This can only be serializable data.
-Shutdowns every current worker in this pool.
+Terminate 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:
@@ -89,11 +93,12 @@'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.
-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.
-The worker tasks queue options.
-The worker choice strategy.
-Optional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
-The worker choice strategy options.
-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.
-