X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=docs%2Finterfaces%2FIPool.html;h=9207f5005de2714305243506df84e80215bc7963;hb=aba8d9bd41f1bd46f3cc3863c0c2e74bdfacb7b6;hp=77f20831cbf6f3a0965f04184af297adb8b1e7c0;hpb=ffc8d14415d44de881ee66ee60fc74da48084976;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 77f20831..9207f500 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.
+Shutdowns every current worker in this pool.
+Terminate every current worker in this pool.
Optional
Readonly
emitterOptional
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.'error'
: Emitted when an uncaught error occurs.'taskError'
: Emitted when an error occurs while executing a task.Performs the task specified in the constructor with the data parameter.
+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.
+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.
+Promise that will be fulfilled when the task is completed.
-Promise that will be resolved when the task is successfully completed.
+Readonly
infoPool information.
+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.
-