X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=b13db3bd94fe758b1c7995771be76339065a6d93;hb=353260e334c7f801b1236890f3a0cb8a98ed2b8e;hp=7efd9779ab1e386b03c87ca8ffb0a7f53c7749e9;hpb=6709f3086622c12bae8060915be7a7f6be9d9763;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 7efd9779..b13db3bd 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 specified function 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.
+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.
The worker tasks queue options.
Sets the worker choice strategy in this pool.
The worker choice strategy.
Optional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsOptional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
Sets the worker choice strategy options in this pool.
The worker choice strategy options.
Readonly
sizePool maximum size.
+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.