Protected Readonly fileProtected Readonly numberProtected Readonly optsProtected promisePrivate Readonly startPrivate Readonly startingProtected workerReadonly workerReadonly Internal workerPool worker nodes.
Protected fullProtected Abstract maxProtected Abstract minPrivate readyProtected Abstract typePrivate utilizationProtected Abstract workerhttps://nodejs.org/api/errors.html#class-error If the added worker node is not found.
Protected afterProtected afterProtected beforePrivate buildPrivate checkProtected checkPrivate checkPrivate checkhttps://nodejs.org/api/errors.html#class-error If the worker id is invalid.
Private checkPrivate checkPrivate checkPrivate checkPrivate checkPrivate chooseProtected createProtected createProtected Abstract createPrivate dequeueProtected Abstract destroyPrivate enqueueExecutes the specified function in the worker constructor with the task data input parameter.
Optional data: DataThe task input data for the specified task function. This can only be structured-cloneable data.
+The optional task input data for the specified task function. This can only be structured-cloneable data.
Optional name: stringThe name of the task function to execute. If not specified, the default task function will be executed.
+The optional name of the task function to execute. If not specified, the default task function will be executed.
+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.
Promise that will be fulfilled when the task is completed.
@@ -760,7 +772,7 @@ Can be overridden.Private executeProtected flushPrivate flushProtected getPrivate getPrivate getPrivate handlePrivate handlePrivate hasProtected internalProtected Abstract isPrivate redistributeProtected Abstract registerPrivate removeProtected sendProtected Abstract sendProtected Abstract sendPrivate sendSends a message to worker given its worker node key.
+Sends the statistics message to worker given its worker node key.
The worker node key.
The message.
-Private sendProtected Abstract sendSends the worker statistics message to worker given its worker node key.
+Sends a message to worker given its worker node key.
The worker node key.
The message.
+Optional transferList: TransferListItem[]The optional array of transferable objects.
+Protected setupPrivate shallPrivate shallWhether the worker node shall update its task function worker usage or not.
+The worker node key.
+true if the worker node shall update its task function worker usage, false otherwise.
Private startPrivate tasksPrivate updatePrivate updatePrivate updatePrivate updateProtected worker
Emitter on which events can be listened to.
Events that can currently be listened to:
-- '
'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.'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 >= pool maximum size^2).