Path to the worker file.
-Options for the pool.
-Events 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).Protected Readonly fileProtected Optional Readonly maxProtected Readonly numberProtected Readonly optsProtected promisePrivate Readonly startPrivate startedPrivate Readonly startingProtected workerReadonly Internal workerProtected fullProtected maxProtected minPrivate readyProtected Abstract typePrivate utilizationProtected Abstract workerThe worker.
-The added worker node key.
https://nodejs.org/api/errors.html#class-error If the added worker node is not found.
Protected afterThe worker node key.
-The received message.
-Protected afterThe newly created worker node key.
-Protected beforeThe worker node key.
-The task to execute.
-Private buildPrivate checkPrivate checkPrivate checkProtected checkPrivate checkPrivate checkThe received message.
-https://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 destroyThe worker node key.
-Whether to enable or disable the worker node tasks queue.
-Optional tasksQueueOptions: TasksQueueOptionsThe worker node tasks queue options.
-Optional
Private enqueueOptional 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.
Private executeThe worker node key.
-The task to execute.
-Protected flushPrivate flushProtected getThe worker node key.
-The worker information.
Private getThe worker.
-The worker node key if found in the pool worker nodes, -1 otherwise.
Private getThe worker id.
-The worker node key if the worker id is found in the pool worker nodes, -1 otherwise.
Private handlePrivate handlePrivate hasThe worker node key.
-true if the worker node has back pressure, false otherwise.
Protected internalProtected Abstract isPrivate redistributeProtected Abstract registerThe worker node key.
-The message listener callback.
Private removeThe worker.
-Protected sendProtected Abstract sendThe worker node key.
-Private sendThe worker node key.
-Protected Abstract sendThe worker node key.
-The message.
-Optional transferList: TransferListItem[]The optional array of transferable objects.
-Optional
Private setThe worker node tasks queue options.
-The worker choice strategy.
-Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
-Optional
The worker choice strategy options.
-Protected setupPrivate shallPrivate shallPrivate shallThe worker node key.
-true if the worker node shall update its task function worker usage, false otherwise.
Private startPrivate taskPrivate tasksPrivate tasksPrivate updatePrivate updatePrivate updatePrivate updatePrivate updateProtected workerGenerated using TypeDoc
Generated using TypeDoc
\ No newline at end of file
Number of workers that this pool should manage.
-