X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=80ced8c2e418c996ae119c266c59b6bcc6f15f90;hb=ae55bb0ecb73cd5cf8d4d5bc62a145e0476aec38;hp=68183a8fc4ca9065feb7818590e33e833ad4d03b;hpb=e7339cfd46bfe4600187ae2c6bd6c9e7f63e7052;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 68183a8f..80ced8c2 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 response of execution. This can only be serializable data.
-Type of execution response. This can only be structured-cloneable data.
+Readonly
busyWhether the pool is busy or not.
-The pool busyness boolean status.
-Shutdowns 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.'error'
: Emitted when an uncaught error occurs.'taskError'
: Emitted when an error occurs while executing a task.Performs the task specified in the constructor with the data parameter.
- -Promise that will be resolved when the task is successfully completed.
+Enables/disables the worker tasks queue in this pool.
The input for the specified task. This can only be serializable data.
-Optional
tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
+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.
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 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
fullWhether the pool is full or not.
-The pool filling boolean status.
-Sets the worker tasks queue options in this pool.
+The worker tasks queue options.
+Sets the worker choice strategy in this pool.
The worker choice strategy.
-Optional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
+Readonly
typePool type.
-If it is 'dynamic'
, it provides the max
property.
Sets the worker choice strategy options in this pool.
+The worker choice strategy options.
+Readonly
workerReadonly
workerPool worker nodes.
-Generated using TypeDoc
Contract definition for a poolifier pool.
-