X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=fa5693f5038395cc509a11608b576aba5a23e309;hb=1d6ec394e8f7467f72baeb74dda4794fdc5ab322;hp=a365532216bb8e1ff0dd64294b0e1c5c5dced6d8;hpb=a76fac14098cf2138cf8d6997ac7c89d8c3ae508;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index a3655322..fa5693f5 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,18 +1,20 @@ -
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.
Shut down every current worker in this pool.
+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.Perform the task specified in the constructor with the data parameter.
+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.
Set the worker choice strategy in this pool.
+Sets the worker choice strategy in this pool.
The worker choice strategy.
Readonly
typePool type.
+If it is 'dynamic'
, it provides the max
property.
Generated using TypeDoc
Contract definition for a poolifier pool.