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.'full': Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.'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.'error': Emitted when an uncaught error occurs.'taskError': Emitted when an error occurs while executing a task.Protected Readonly fileProtected Readonly numberProtected Readonly optsProtected promisePrivate Readonly startThe start timestamp of the pool.
+Protected workerWorker choice strategy context referencing a worker choice algorithm implementation.
-Default to a round robin algorithm.
Readonly workerPool worker nodes.
Protected fullProtected Abstract maxProtected Abstract minPrivate readyPrivate startingProtected Abstract typePrivate utilizationGets the approximate pool utilization.
+The pool utilization.
+ +Protected Abstract workerPrivate addProtected afterThe received message.
Protected Abstract 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.
Function that can be hooked up when a worker has been newly created and moved to the pool worker nodes. +Can be overridden.
Protected beforeHook executed before the worker task execution. Can be overridden.
@@ -380,11 +451,16 @@ Can be overridden.The worker node key.
The task to execute.
+Private buildPrivate checkProtected checkPrivate checkPrivate checkChecks if the worker id sent in the received message from a worker is valid.
+The received message.
+https://nodejs.org/api/errors.html#class-error If the worker id is invalid.
+Private checkPrivate checkPrivate checkPrivate checkPrivate checkProtected choosePrivate chooseProtected createProtected createProtected Abstract createReturns a newly created worker.
+Creates a new worker.
Newly created worker.
+ +Private dequeueShutdowns every current worker in this pool.
+Terminates every current worker in this pool.
Protected Abstract destroyShutdowns the given worker.
+Terminates the given worker.
Private enqueueOptional data: DataThe task input data for the specified worker function. This can only be serializable data.
+The task input data for the specified worker function. This can only be structured-cloneable data.
Private executeExecutes the given task on the given worker.
+Private flushPrivate flushPrivate getPrivate getGets the worker information.
+The worker node key.
+Private getThe worker.
The worker node key if the worker is found in the pool worker nodes, -1 otherwise.
The worker node key if found in the pool worker nodes, -1 otherwise.
Private handlePrivate handleProtected internalProtected Abstract isPrivate pushPrivate redistributePushes the given worker in the pool worker nodes.
-The worker.
-The worker nodes length.
- -Protected Abstract registerPrivate registerRegisters a listener callback on the given worker.
@@ -759,12 +952,12 @@ Can be overridden.Private removeProtected Abstract sendThe message.
Private sendThe worker choice strategy.
Private setPrivate setSets the given worker in the pool worker nodes.
-The worker node key.
-The worker.
-The worker tasks usage.
-The worker task queue.
-Private setSets the given worker node its tasks usage in the pool.
-The worker node.
-The worker node tasks usage.
-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.
Private shallPrivate tasksPrivate updatePrivate updatePrivate updatePrivate updatePrivate updatePrivate updateProtected workerThe listener function to execute when a message is received from a worker.
Generated using TypeDoc
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.
@@ -66,6 +66,7 @@ number