X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=394e14c9f03a68fa75aa5f00554442a72060ac1e;hb=f38f85c043864b68ea519f6bdf94821c356195f1;hp=36b35e12a2e51561032948b804eb98e5176c7773;hpb=d0f1dce33156fdb99f0ca3627839001909419497;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 36b35e12..42ed5c38 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,18 +1,345 @@ -
Type of data sent to the worker. This can only be serializable data.
-Type of response of execution. This can only be serializable data.
-Shut down every current worker in this pool.
-Perform the task specified in the constructor with the data parameter.
-The input for the specified task. This can only be serializable data.
-Promise that will be resolved when the task is successfully completed.
-Set the worker choice strategy in this pool.
-The worker choice strategy.
-Generated using TypeDoc
Contract definition for a poolifier pool.
+Type of worker which manages this pool.
+Type of data sent to the worker. This can only be structured-cloneable data.
+Type of execution response. This can only be structured-cloneable data.
+Readonly
destroyTerminates 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 the number of workers created has reached the maximum size expected.'ready'
: Emitted when the number of workers created in the pool has reached the minimum size expected and are ready.'busy'
: Emitted when the number of workers created in the pool has reached the maximum size expected and are executing at least one task.'error'
: Emitted when an uncaught error occurs.'taskError'
: Emitted when an error occurs while executing a task.Readonly
enableEnables/disables the worker tasks queue in this pool.
+Whether to enable or disable the worker tasks queue.
+Optional
tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
+Readonly
executeExecutes 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 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.
+Readonly
setSets the worker tasks queue options in this pool.
+The worker tasks queue options.
+Readonly
setSets the worker choice strategy in this pool.
+The worker choice strategy.
+Optional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
+Readonly
setSets the worker choice strategy options in this pool.
+The worker choice strategy options.
+Readonly
workerPool worker nodes.
+Generated using TypeDoc
Contract definition for a poolifier pool.
-