X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=docs%2Finterfaces%2FIPool.html;h=ff7878f0b7e8b6b16d6551605d12b7ca51350006;hb=717e9363ccc3cfdbd24bda1bd019d31274163b10;hp=7205a9f1379b20393b207782b2df174c2fc238a5;hpb=b7e141c40bccfd7a4ec0ff98b7829f7d296f048b;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 7205a9f1..ff7878f0 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,13 +1,13 @@ -
Readonly
destroyReadonly
destroyOptional
Readonly
emitterReadonly
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
startStarts the minimum number of workers in this pool.
+Readonly
Internal
workerGenerated using TypeDoc
Whether to enable or disable the worker node tasks queue.
-