X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=e0c80130e9ea5c8f7c96a22c9caaac6fac09428f;hb=9954c636f2caafac0b2bf0289059788679fd3053;hp=bb275d41748743cf0ffc26295ad4da9de761289a;hpb=d6b93f1ae5603949390418b787e0ad51b026f9c5;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index bb275d41..e0c80130 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -31,7 +31,7 @@
Optional
Readonly
emitterEnables/disables the worker tasks queue in this pool.
+Whether to enable or disable the worker tasks queue.
+Optional
tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
+Performs the task specified in the constructor with the data parameter.
+Executes the function specified in the worker constructor with the task data input parameter.
-Promise that will be resolved when the task is successfully completed.
+Promise that will be fulfilled when the task is completed.
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.
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.
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.
+Sets the worker choice strategy options in this pool.
+The worker choice strategy options.
Readonly
typeIf it is 'dynamic'
, it provides the max
property.
Readonly
workerPool worker nodes.
Type of response of execution. This can only be serializable data.
+Type of execution response. This can only be serializable data.
Hierarchy
@@ -42,7 +42,7 @@@@ -52,9 +52,12 @@destroy
emitter?
+enable Tasks Queue
execute
find Free Worker Node Key
+set Tasks Queue Options
set Worker Choice Strategy
+set Worker Choice Strategy Options
type
worker Nodes
Properties