X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=docs%2Finterfaces%2FIPool.html;h=78acb1c92fad7956b4ad292dbf6c135d5b10015a;hb=956cfeccbd168a90f3d9acb1729975cf3f861a77;hp=61d1b615339d614f5a4bdc682e20f12d7041e67f;hpb=812ad701baefad24cad2df8f9a60bf4d581d8697;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 61d1b615..78acb1c9 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.
Shutdowns every current worker in this pool.
Optional
Readonly
emitterEmitter on which events can be listened to.
Events that can currently be listened to:
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.
+Executes the specified function in the worker constructor with the task data input parameter.
+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.
+Performs the task specified in the constructor with the data parameter.
- -Promise that will be resolved when the task is successfully completed.
+Sets the worker tasks queue options in this pool.
The input for the specified task. This can only be serializable data.
+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
sizePool maximum size.
+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.