Path to an implementation of a ClusterWorker file, which can be relative or absolute.
Options for this fixed cluster pool.
-'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.'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 >= pool maximum size^2).'backPressure': Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size >= maximum queue size).Protected Readonly fileProtected Optional Readonly maxProtected Readonly numberProtected Readonly optsProtected promiseProtected workerReadonly Internal workerProtected fullProtected maxProtected minPrivate readyProtected typePrivate utilizationProtected workerThe worker node key.
-The received message.
-Protected afterThe newly created worker node key.
-Protected beforeThe worker node key.
-The task to execute.
-Protected checkProtected createProtected createProtected createProtected destroyThe worker node key.
-Enables/disables the worker tasks queue in this pool.
+Enables/disables the worker node tasks queue in this pool.
Whether to enable or disable the worker tasks queue.
-Whether to enable or disable the worker node tasks queue.
+Optional tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
-The worker node tasks queue options.
+Optional 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.
Protected flushProtected getGets the worker information given its worker node key.
The worker node key.
-The worker information.
+ +The worker information.
The worker node key.
-true if the worker node has back pressure, false otherwise.
Protected internalProtected isProtected registerThe worker node key.
-The message listener callback.
Protected sendProtected sendThe worker node key.
-Protected sendThe worker node key.
-The message.
-Sets 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.
+The worker choice strategy.
-Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
-Optional
The worker choice strategy options.
-Protected setupProtected workerGenerated using TypeDoc
Generated using TypeDoc
\ No newline at end of file
Number of workers for this pool.
-