X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=379d6c3b358825df2004d517c4ea64c9ed5d3ffc;hb=842d8918a19fc2720d4436789a2e373bc623452e;hp=36b35e12a2e51561032948b804eb98e5176c7773;hpb=d0f1dce33156fdb99f0ca3627839001909419497;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 36b35e12..379d6c3b 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,18 +1,259 @@ -
Type of data sent to the worker. This can only be serializable data.
-Type of response of execution. This can only be serializable data.
-Shut down every current worker in this pool.
-Perform the task specified in the constructor with the data parameter.
-The input for the specified task. This can only be serializable data.
-Promise that will be resolved when the task is successfully completed.
-Set the worker choice strategy in this pool.
-The worker choice strategy.
-Generated using TypeDoc
Contract definition for a poolifier pool.
+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.
+Readonly
busyWhether the pool is busy or not.
+The pool busyness boolean status.
+Shutdowns every current worker in this pool.
+Optional
Readonly
emitterEmitter on which events can be listened to.
+Events that can currently be listened to:
+'full'
: Emitted when the pool is dynamic and full.'busy'
: Emitted when the pool is busy.Performs the task specified in the constructor with the data parameter.
+ +Promise that will be resolved when the task is successfully completed.
+The input for the specified task. 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.
Readonly
fullWhether the pool is full or not.
+The pool filling boolean status.
+Sets the worker choice strategy in this pool.
+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.
-