X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=docs%2Finterfaces%2FIPool.html;h=b410d044d298f91e3f64b94fe4504ba845dfa40d;hb=8e76d7c1a709d06c460a609b1124b0ade6ae3c52;hp=69711be11dae3141798bc83c5cd2c6b054c4db07;hpb=c8a9d1714b7b1d592a73751ad6f580121cf75f7f;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 69711be1..b410d044 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,13 +1,13 @@ -
Readonly
addThe name of the task function.
+The task function.
+true
if the task function was added, false
otherwise.
https://nodejs.org/api/errors.html#class-typeerror If the name
parameter is not a string or an empty string.
https://nodejs.org/api/errors.html#class-typeerror If the fn
parameter is not a function.
Readonly
destroyReadonly
destroyTerminates all workers in this pool.
Optional
Readonly
emitterEmitter on which events can be listened to.
+Event emitter integrated with async resource on which events can be listened to.
+The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool
.
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.Readonly
enableEnables/disables the worker node tasks queue in this pool.
Whether to enable or disable the worker node tasks queue.
-Optional
tasksQueueOptions: TasksQueueOptionsThe worker node tasks queue options.
-Optional
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
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
hasWhether the specified task function exists in this pool.
+The name of the task function.
+true
if the task function exists, false
otherwise.
Readonly
hasInternal
Whether the worker node has back pressure (i.e. its tasks queue is full).
The worker node key.
-true
if the worker node has back pressure, false
otherwise.
Readonly
infoReadonly
listReadonly
listLists the names of task function available in this pool.
Readonly
removeRemoves a task function from this pool.
+The name of the task function.
+true
if the task function was removed, false
otherwise.
Readonly
setSets the default task function in this pool.
+The name of the task function.
+true
if the default task function was set, false
otherwise.
Readonly
setSets the worker node tasks queue options in this pool.
The worker node tasks queue options.
-Readonly
setSets the worker choice strategy in this pool.
The worker choice strategy.
-Optional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
-Optional
Readonly
setSets the worker choice strategy options in this pool.
The worker choice strategy options.
-Readonly
startStarts the minimum number of workers in this pool.
+Readonly
Internal
workerGenerated using TypeDoc
Adds a task function to this pool. +If a task function with the same name already exists, it will be overwritten.
+