X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Finterfaces%2FIPool.html;h=b3ec1fcd098b9a7c331027fd555c2115cbef04e9;hb=15bb637a91abd156aae586ce14c663101a8c6697;hp=68183a8fc4ca9065feb7818590e33e833ad4d03b;hpb=e7339cfd46bfe4600187ae2c6bd6c9e7f63e7052;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 68183a8f..b3ec1fcd 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -31,7 +31,7 @@
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.
+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.
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.
+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 @@@@ -50,28 +50,21 @@
busy
-destroy
+destroy
emitter?
+enable Tasks Queue
execute
find Free Worker Node Key
-full
+set Tasks Queue Options
set Worker Choice Strategy
+set Worker Choice Strategy Options
type
worker Nodes
-busy: boolean
-
-destroy: (() => Promise<void>)
Properties
-Properties
-
-Readonly
busyWhether the pool is busy or not.
-The pool busyness boolean status.
-destroy
+destroy
Type declaration
@@ -84,7 +77,7 @@Returns Promise<void>
Optional
Readonly
emitter