Optional Readonly emitterEvents 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.'busy': Emitted when the number of workers created in the pool has reached the maximum size expected and are executing at least one task.'busy': Emitted when the number of workers created in the pool has reached the maximum size expected and are executing concurrently their tasks quota.'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 enableReadonly 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 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 listLists the names of task function available in this pool.
Readonly setSets the worker tasks queue options in this pool.
+Sets the worker node tasks queue options in this pool.
The worker tasks queue options.
-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 workerReadonly Internal workerPool worker nodes.
Generated using TypeDoc
Generated using TypeDoc
\ No newline at end of file
Enables/disables the worker tasks queue in this pool.
+Enables/disables the worker node tasks queue in this pool.
Parameters
enable: boolean
-Whether to enable or disable the worker tasks queue.
-Whether to enable or disable the worker node tasks queue.
+
-OptionaltasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
-The worker node tasks queue options.
+Optional