X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=80d249d564d190cbd12f125920cc5522affa6259;hb=3a592a1254b999797590d1b54662b747eed17528;hp=394e14c9f03a68fa75aa5f00554442a72060ac1e;hpb=53221c4e8cbcc585c670275e7c1c700c3d1b5f37;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 394e14c9..80d249d5 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,4 +1,4 @@ -
Executes the function specified in the constructor with the task data parameter.
- -Promise that will be resolved when the task is successfully completed.
+Executes the function specified in the worker constructor with the task data input parameter.
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.
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.
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.
Generated using TypeDoc
Contract definition for a poolifier pool.