X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=143016d733dec7ba2af14088f9e68daa9ac12b82;hb=b7076c9f9bff47cc233fb67df43ae160680c6d6e;hp=0b232f29be2d00227a28ed520f67771f3a571334;hpb=6c525543a7ed67a926b7c1f4bf98985aaad1f088;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 0b232f29..143016d7 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 constructor with the task data input parameter.
Promise that will be resolved when the task is successfully completed.
The input for the specified task. This can only be serializable data.
+The task input data for the specified 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
typePool type.
If 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