X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=docs%2Finterfaces%2FIPool.html;h=b13db3bd94fe758b1c7995771be76339065a6d93;hb=dab8c377b70fc962ec217f2aeb719842f9f94cd6;hp=aeab85fd7a9c721102d935e0339bad088bc0df3b;hpb=356d077f5c6166732d2df598004bec39ae915725;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index aeab85fd..b13db3bd 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
emitterShutdowns every current worker in this pool.
+Optional
Readonly
emitterEmitter on which events can be listened to.
Events that can currently be listened to:
'busy'
'full'
: Emitted when the pool is dynamic and full.'busy'
: Emitted when the pool is busy.Shutdowns every current worker in this pool.
+Enables/disables the worker tasks queue in this pool.
Whether to enable or disable the worker tasks queue.
+Optional
tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
+Performs the task specified in the constructor with the 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.
Promise that will be fulfilled when the task is completed.
+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: 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.