Readonly setSets the worker choice strategy in this pool.
The worker choice strategy.
Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
-Readonly setSets the worker choice strategy options in this pool.
+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 workerPool worker nodes.
-Generated using TypeDoc
Readonly startStarts the minimum number of workers in this pool.
+Readonly Internal workerPool worker nodes.
+
Contract definition for a poolifier pool.
+- Preparing search index...
- The search index is not available
poolifier - v3.1.30Interface IPool<Worker, Data, Response>
Contract definition for a poolifier pool.
    addTaskFunction: ((name, fn) => Promise<boolean>);
    destroy: (() => Promise<void>);
    emitter?: EventEmitterAsyncResource;
    enableTasksQueue: ((enable, tasksQueueOptions?) => void);
    execute: ((data?, name?, transferList?) => Promise<Response>);
    hasTaskFunction: ((name) => boolean);
    info: PoolInfo;
    listTaskFunctionNames: (() => string[]);
    removeTaskFunction: ((name) => Promise<boolean>);
    setDefaultTaskFunction: ((name) => Promise<boolean>);
    setTasksQueueOptions: ((tasksQueueOptions) => void);
    setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void);
    setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void);
    start: (() => void);
    workerNodes: IWorkerNode<Worker, Data>[];
}
Type Parameters
Type of worker which manages this pool.
Type of data sent to the worker. This can only be structured-cloneable data.
Type of execution response. This can only be structured-cloneable data.
-Implemented by
Index
Properties
Implemented by
Index
Properties
Returns Promise<boolean>
Returns
trueif the task function was added,falseotherwise.Throws
https://nodejs.org/api/errors.html#class-typeerror If the
nameparameter is not a string or an empty string.Throws
https://nodejs.org/api/errors.html#class-typeerror If the
-fnparameter is not a function.ReadonlydestroyTerminates all workers in this pool.
-Type declaration
Returns Promise<void>
OptionalReadonlyemitterPool event emitter integrated with async resource. +
ReadonlydestroyTerminates all workers in this pool.
+Type declaration
Returns Promise<void>
OptionalReadonlyemitterPool event emitter integrated with async resource. The async tracking tooling identifier is
poolifier:<PoolType>-<WorkerType>-pool.Events that can currently be listened to:
@@ -38,33 +38,33 @@ The async tracking tooling identifier is
-poolifier:<PoolType>-<Wo'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).ReadonlyenableEnables/disables the worker node tasks queue in this pool.
+ReadonlyenableEnables/disables the worker node tasks queue in this pool.
Type declaration
Parameters
Whether to enable or disable the worker node tasks queue.
OptionaltasksQueueOptions: TasksQueueOptionsThe worker node tasks queue options.
-Returns void
ReadonlyexecuteExecutes the specified function in the worker constructor with the task data input parameter.
+Returns void
ReadonlyexecuteExecutes the specified function in the worker constructor with the task data input parameter.
Type declaration
Parameters
Optionaldata: DataThe optional task input data for the specified task function. This can only be structured-cloneable data.
Optionalname: stringThe optional name of the task function to execute. If not specified, the default task function will be executed.
-OptionaltransferList: TransferListItem[]An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the chosen pool's worker_threads worker and they should not be used in the main thread afterwards.
+OptionaltransferList: readonly TransferListItem[]An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the chosen pool's worker_threads worker and they should not be used in the main thread afterwards.
Returns Promise<Response>
Returns
Promise that will be fulfilled when the task is completed.
-ReadonlyhasWhether the specified task function exists in this pool.
+ReadonlyhasWhether the specified task function exists in this pool.
Type declaration
Parameters
The name of the task function.
Returns boolean
Returns
-trueif the task function exists,falseotherwise.ReadonlyinfoPool information.
-ReadonlylistLists the names of task function available in this pool.
+ReadonlyinfoPool information.
+ReadonlylistLists the names of task function available in this pool.
Type declaration
Returns string[]
Returns
The names of task function available in this pool.
-ReadonlyremoveRemoves a task function from this pool.
+ReadonlyremoveRemoves a task function from this pool.
Type declaration
Parameters
The name of the task function.
Returns Promise<boolean>
Returns
-trueif the task function was removed,falseotherwise.ReadonlysetSets the default task function in this pool.
+ReadonlysetSets the default task function in this pool.
Type declaration
Parameters
The name of the task function.
Returns Promise<boolean>
Returns
-trueif the default task function was set,falseotherwise.ReadonlysetSets the worker node tasks queue options in this pool.
+ReadonlysetSets the worker node tasks queue options in this pool.
Type declaration
Parameters
The worker node tasks queue options.
-Returns void
ReadonlysetSets the worker choice strategy in this pool.
+Returns void