X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=92f13dd905df1ab0c97e3351d6517be76ad1b2d0;hb=2c554f901fef98264049ae8b831df8803e3e3619;hp=c7fe36db8141f5140f5e252b6f3fed5e2eb08794;hpb=0c1d2aee9268a3d1cad693d46d3ffe253e1f6a41;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index c7fe36db..92f13dd9 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 data sent to the worker. This can only be structured-cloneable data.
+Type of response of execution. This can only be serializable data.
-Type of execution response. This can only be structured-cloneable data.
+Optional
Readonly
emitterReadonly
destroyTerminates all workers 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 the number of workers created has reached the maximum size expected.'ready'
: Emitted when the number of workers created in the pool has reached the minimum size expected and are ready.'busy'
: Emitted when the number of workers created in the pool has reached the maximum size expected and are executing at least one task.'error'
: Emitted when an uncaught error occurs.'taskError'
: Emitted when an error occurs while executing a task.Readonly
enableShutdowns 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.
+Readonly
executePerforms the task specified in the constructor with the data parameter.
+Executes the specified function in the worker constructor with the task data input parameter.
+Optional
data: DataThe optional task input data for the specified task function. This can only be structured-cloneable data.
+Optional
name: stringThe optional name of the task function to execute. If not specified, the default task function will be executed.
+Optional
transferList: TransferListItem[]An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the pool's worker_threads worker and they should not be used in the main thread afterwards.
+Promise that will be fulfilled when the task is completed.
-Promise that will be resolved when the task is successfully completed.
+Readonly
infoPool information.
+Readonly
setSets 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.
+Readonly
setSets the worker choice strategy in this pool.
The worker choice strategy.
-Optional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
+Generated using TypeDoc
Contract definition for a poolifier pool.
-