X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Finterfaces%2FIPool.html;h=0c22722b96bf9a41becf44dc0b8b7c85a7cdf5be;hb=8d98e603c79d8d00b2b6a33e5f732701a7466234;hp=7911f61f194612f589612577ae878dc8cc2912f9;hpb=15e4d8f3cafe9f7412913b0e440921e813bdf3cd;p=poolifier.git
diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html
index 7911f61f..0c22722b 100644
--- a/docs/interfaces/IPool.html
+++ b/docs/interfaces/IPool.html
@@ -18,9 +18,9 @@
Type Parameters
-
+
Worker extends IWorker
Returns Promise<void>
Optional
Readonly
emitter'full'
: Emitted when the pool is dynamic and full.'busy'
: Emitted when the pool is busy.'error'
: Emitted when an uncaught error occurs.'taskError'
: Emitted when an error occurs while executing a task.Executes 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.
Readonly
infoPool information.
+The worker choice strategy.
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.