X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=docs%2Finterfaces%2FIPool.html;h=e8b72506f4c49ce6987cf3c620b54dd1296f57f9;hb=4ba4c7f958c50c9e734effb61831b9acfed2fd79;hp=be3a79ec511de8d07ce7f1e30f2b5ac64c33673a;hpb=0bb3df76aeab8a2af9e99ccf91d9e9cc5e751674;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index be3a79ec..e8b72506 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,4 +1,4 @@ -
Optional
Readonly
emitter'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.'destroy'
: Emitted when the pool is destroyed.'error'
: Emitted when an uncaught error occurs.'taskError'
: Emitted when an error occurs while executing a task.'backPressure'
: Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size >= maximum queue size).Readonly
enableOptional
tasksQueueOptions: TasksQueueOptionsThe worker node tasks queue options.
-Optional
Readonly
executeOptional
data: DataThe optional task input data for the specified task function. This can only be structured-cloneable data.
-Optional
Optional
name: stringThe optional name of the task function to execute. If not specified, the default task function will be executed.
-Optional
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.
-Optional
Promise that will be fulfilled when the task is completed.
Readonly
hasThe worker node key.
-true
if the worker node has back pressure, false
otherwise.
Readonly
infoReadonly
listReadonly
setThe worker node tasks queue options.
-Readonly
setThe worker choice strategy.
-Optional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
-Optional
Readonly
setThe worker choice strategy options.
-Readonly
Internal
workerGenerated using TypeDoc
Generated using TypeDoc
\ No newline at end of file
Whether to enable or disable the worker node tasks queue.
-