X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Finterfaces%2FIPool.html;h=b3ec1fcd098b9a7c331027fd555c2115cbef04e9;hb=15bb637a91abd156aae586ce14c663101a8c6697;hp=85d72c2c68c0e9166e8762d990cfe8995d8a047c;hpb=71a64eca52278c2396cf7cb6e6c53fce3704f5ab;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 85d72c2c..b3ec1fcd 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,4 +1,4 @@ -
Type of worker which manages this pool.
+Type of data sent to the worker. This can only be serializable data.
Type of response of execution. This can only be serializable data.
+Type of execution response. This can only be serializable data.
Optional
Readonly
emitterEnables/disables the worker tasks queue in this pool.
+Whether to enable or disable the worker tasks queue.
+Optional
tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
+Executes the function specified in the worker constructor with the task data input parameter.
+ +Promise that will be fulfilled when the task is completed.
+Optional
data: DataThe task input data for the specified worker function. This can only be serializable data.
+Performs the task specified in the constructor with the data parameter.
+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.
Promise that will be resolved when the task is successfully completed.
+A worker node key if there is one, -1
otherwise.
Sets the worker tasks queue options in this pool.
The input for the specified task. This can only be serializable data.
+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.
Generated using TypeDoc
Contract definition for a poolifier pool.