X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=1135bfdc7c48600d194d29e380410af18d594b98;hb=c9f8e5d3a3d92ae49257929ad172afc1e9c5630d;hp=39bf3862b55dde4572e9e3f553d8d0e96955d5d7;hpb=fec1c97860619dd6356803fee392205474010d5b;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 39bf3862..1135bfdc 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,84 +1,227 @@ -
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.
+Readonly
destroyShutdowns every current worker in this pool.
+Terminates all workers in this pool.
+Optional
Readonly
emitterEmitter on which events can be listened to.
+Events that can currently be listened to:
+'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.'full'
: Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.destroy
': Emitted when the pool is destroyed.'error'
: Emitted when an uncaught error occurs.'taskError'
: Emitted when an error occurs while executing a task.Readonly
enablePerforms 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.
+Readonly
executeExecutes 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
listLists the names of task function available in this pool.
+The names of task function available in this pool.
+ +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.
-