X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Finterfaces%2FIPool.html;h=93f4694004b0290113fc74ab1cb6a676cc29565e;hb=460aaab4b4cb6857827d3e56e11122bffc01db8a;hp=ab6163b1b8706be6af794872a3c8e1c695a049ab;hpb=b142df6d1278e9d0b6c4c7226bf3dae36c486410;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index ab6163b1..93f46940 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,101 +1,238 @@ -
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.'error'
: Emitted when an uncaught error occurs.'taskError'
: Emitted when an error occurs while executing a task.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.
+Perform the task specified in the constructor with the data parameter.
- -Promise that will be resolved when the task is successfully completed.
+Executes the specified function 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.
+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.
+Sets the worker tasks queue options in this pool.
+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.
Generated using TypeDoc
Contract definition for a poolifier pool.