X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Finterfaces%2FIPool.html;h=a0209041034a98239dc1d4d2c443a4a3f323d318;hb=3e9ac5c983766ff74aeedfe5c9ac43096550487a;hp=5274df40b196da4719e2c1013123380da7a9fae6;hpb=8c25f12d41260092a30cfb47feeb662140943302;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 5274df40..a0209041 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.
-