Emitter on which events can be listened to.
Events that can currently be listened to:
'full': Emitted when the pool is dynamic and full.'busy': Emitted when the pool is busy.'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 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.'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).Protected Readonly fileProtected Readonly maxMaximum number of workers that can be created by this pool.
Protected Readonly numberProtected Readonly optsProtected promiseThe execution response promise map.
+ +The task execution response promise map.
key: The message id of each submitted task.value: An object that contains the worker, the execution response promise resolve and reject callbacks.Protected workerReadonly workerReadonly Internal workerPool worker nodes.
Protected fullProtected maxPool maximum size.
+The pool maximum size.
Protected minPool minimum size.
+The pool minimum size.
Private readyThe pool readiness boolean status.
+Protected typePool type.
+The pool type.
If it is 'dynamic', it provides the max property.
Private utilizationThe approximate pool utilization.
+The pool utilization.
+ +Protected workerGets the worker type.
+The worker type.
Protected afterHook executed after the worker task execution. Can be overridden.
@@ -330,41 +364,38 @@ Can be overridden.The worker.
-The worker node key.
+The received message.
-Protected afterProtected afterFunction that can be hooked up when a worker has been newly created and moved to the pool worker nodes.
-Can be used to update the maxListeners or binding the main-worker<->worker connection if not bind by default.
Method hooked up after a worker node has been newly created. +Can be overridden.
The newly created worker.
-The newly created worker node key.
+Protected beforeThe worker node key.
-The task to execute.
-Protected chooseProtected checkChooses a worker node for the next task.
-The default worker choice strategy uses a round robin algorithm to distribute the load.
+Protected createProtected createProtected createCreates a new worker and sets it up completely in the pool worker nodes.
+Creates a new, completely set up worker node.
New, completely set up worker.
+New, completely set up worker node key.
+Protected createReturns a newly created worker.
+Creates a new worker.
Newly created worker.
+ +Shutdowns every current worker in this pool.
+Terminates all workers in this pool.
Protected destroyProtected destroyShutdowns the given worker.
+Terminates the worker node given its worker node key.
A worker within workerNodes.
The 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 Executes the specified function in the worker constructor with the task data input parameter.
Optional data: DataThe task input data for the specified worker function. This can only be serializable data.
-The optional task input data for the specified task function. This can only be structured-cloneable data.
+Optional Optional name: stringThe name of the worker function to execute. If not specified, the default worker function will be executed.
-The 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.
+ +Protected internalProtected isProtected registerRegisters a listener callback on the given worker.
+Registers a listener callback on the worker given its worker node key.
The worker which should register a listener.
-The worker node key.
+The message listener callback.
Protected sendProtected sendProtected sendSends a message to the given worker.
+Sends a message to worker given its worker node key.
The worker which should receive the message.
-The 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 setupSetup hook to execute code before worker node are created in the abstract constructor. -Can be overridden
+Setup hook to execute code before worker nodes are created in the abstract constructor. +Can be overridden.
Protected workerThis function is the listener registered for each worker message.
+This method is the listener registered for each worker message.
The listener function to execute when a message is received from a worker.
@@ -692,20 +834,20 @@ Can be overriddenThis function is the listener registered for each worker message.
+This method is the listener registered for each worker message.
The listener function to execute when a message is received from a worker.
Generated using TypeDoc
Generated using TypeDoc
\ No newline at end of file
Type of data sent to the worker. This can only be serializable data.
+Type of data sent to the worker. This can only be structured-cloneable data.
Response = unknown
-Type of execution response. This can only be serializable data.
+Type of execution response. This can only be structured-cloneable data.
@@ -59,7 +59,7 @@ When the maximum number of workers is reached and workers are busy, an event isemitter?
filebusy
full
info
-max
after-
+
-
+
-
+
Properties
Methods
min: number
Minimum number of workers which are always active.
-max: number
Maximum number of workers that can be created by this pool.
-filePath: string
Path to an implementation of a
-ClusterWorkerfile, which can be relative or absolute.opts: ClusterPoolOptions = {}
Options for this dynamic cluster pool.
-