X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=2e4ac39bb2c6b59b9a53c46f17524edb637d9eca;hb=5e972953bf3193a557a14fa794d559b2acc1d6de;hp=b314d771a729005b972e962e4556c3111b8d5b84;hpb=d655c2c2b159a39f900230c14b301ba123653362;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index b314d771..98a3dbfb 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 data sent to the worker. This can only be structured-cloneable data.
+Type of execution response. This can only be serializable data.
-Type of execution response. This can only be structured-cloneable data.
+Readonly
destroyShutdowns every current worker in this pool.
+Terminates 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:
'full'
: Emitted when the pool is dynamic and full.'busy'
: Emitted when the pool is busy.'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: TasksQueueOptionsOptional
tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
-Readonly
executeExecutes the function specified in the constructor with the task 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.
-Finds a free worker node key based on the number of tasks the worker has applied.
-If a worker is found with 0
running tasks, it is detected as free and its worker node key is returned.
If no free worker is found, -1
is returned.
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.
-A worker node key if there is one, -1
otherwise.
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: WorkerChoiceStrategyOptionsOptional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
-Readonly
setSets the worker choice strategy options in this pool.
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.
-