X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=4abbb36f0841376b114884c7ab246ad66886dcf2;hb=cac70359b46b8437dd8d23ef6176c6cdfd187c0c;hp=488af2256da5e6129e0d55a34e7cda2bc7b4bea0;hpb=248bc34b348a7d8d2b90eecff49d60a3b465da9e;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 488af225..4abbb36f 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,101 +1,245 @@ -
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:
+'full'
: Emitted when the pool is dynamic and full.'busy'
: Emitted when the pool is busy.Shut down 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.
+Executes the function specified 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.
+Perform 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.
Set the worker choice strategy in this pool.
+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.
Generated using TypeDoc
Contract definition for a poolifier pool.