X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=78acb1c92fad7956b4ad292dbf6c135d5b10015a;hb=956cfeccbd168a90f3d9acb1729975cf3f861a77;hp=c6e2995e72f26d899d8bb6aaed60a5b8c82f28e3;hpb=8d1797ad15cb2d87ac3c9904ce6df3db45c0c742;p=poolifier.git
diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html
index c6e2995e..78acb1c9 100644
--- a/docs/interfaces/IPool.html
+++ b/docs/interfaces/IPool.html
@@ -18,9 +18,9 @@
Type Parameters
-
+
Worker extends IWorker
Optional
Readonly
emitterExecutes the function specified in the worker constructor with the task data input parameter.
- -Promise that will be fulfilled when the task is completed.
+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 serializable data.
+Optional
name: stringThe name of the worker function to execute. If not specified, the default worker function will be executed.
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.
A worker node key if there is one, -1
otherwise.
Sets the worker tasks queue options in this pool.
Sets the worker choice strategy in this pool.
Sets the worker choice strategy options in this pool.
Readonly
sizePool maximum size.
+Readonly
typeIf it is 'dynamic'
, it provides the max
property.
Readonly
workerPool worker nodes.
Contract definition for a poolifier pool.