Event emitter integrated with async resource on which events can be listened to.
+The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool.
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).
Executes the specified function in the worker constructor with the task data input parameter.
@@ -624,12 +849,17 @@ Can be overridden.
Optionaldata: Data
-
The 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.
Optionalname: string
-
The 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.
+
+
+
+
OptionaltransferList: 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.
Returns Promise<Response>
Promise that will be fulfilled when the task is completed.
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.
-
+Index
Index
Constructors
-Properties
-Accessors
-Methods
-Constructors
constructor
+constructor
Type Parameters
Worker extends IWorker<Worker>
Worker extends IWorker
Data = unknown
Returns AbstractPool<Worker, Data, Response>
Properties
-OptionalReadonlyemitterEmitter on which events can be listened to.
+
+OptionalemitterEvent emitter integrated with async resource on which events can be listened to. +The async tracking tooling identifier is
poolifier:<PoolType>-<WorkerType>-pool.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).ProtectedReadonlyfile
+ProtectedOptionalReadonlymaxDynamic pool maximum size property placeholder.
+ProtectedReadonlynumberProtectedReadonlyopts
-ProtectedpromiseThe 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.
+PrivateReadonlystartThe start timestamp of the pool.
+
+PrivatestartedWhether the pool is started or not.
+
+PrivatestartingWhether the pool is starting or not.
+
+PrivateReadonlytaskThe task functions added at runtime map:
++
+key: The task function name.value: The task function itself.ProtectedworkerWorker choice strategy context referencing a worker choice algorithm implementation.
-Default to a round robin algorithm.
-Readonlyworker
+ReadonlyInternalworkerPool worker nodes.
Accessors
Returns boolean
Protectedfull@@ -263,7 +348,7 @@
Returns boolean
info
@@ -275,58 +360,134 @@
+ProtectedAbstractmaxProtectedmaxPool maximum size.
+The pool maximum size.
Returns number
+
+ProtectedAbstractminProtectedminPool minimum size.
+The pool minimum size.
Returns number
+
+Privateready+- get ready(): boolean
+-
+
The pool readiness boolean status.
+Returns boolean
+ProtectedAbstracttypePool type.
+The pool type.
If it is
'dynamic', it provides themaxproperty.Returns "fixed" | "dynamic"
+
+Privateutilization+- get utilization(): number
+-
+
The approximate pool utilization.
+Returns number
The pool utilization.
+ +ProtectedAbstractworker-- get worker(): "cluster" | "thread"
+- get worker(): "thread" | "cluster"
-
-
- Defined in src/pools/abstract-pool.ts:472
+
+
+
-
-- Defined in src/pools/abstract-pool.ts:170
+
+
Gets the worker type.
+The worker type.
Returns "cluster" | "thread"
+Returns "thread" | "cluster"
+Methods
+add
++- add
+-
+
+
+
+
Adds a task function to this pool. +If a task function with the same name already exists, it will be overwritten.
+Parameters
++-
+
+-
+
name: string
+The name of the task function.
+fn: TaskFunction<Data, Response>
+The task function.
+Returns Promise<boolean>
+ +trueif the task function was added,falseotherwise.Throws
https://nodejs.org/api/errors.html#class-typeerror If the
+ +nameparameter is not a string or an empty string.Throws
https://nodejs.org/api/errors.html#class-typeerror If the
+fnparameter is not a function.
+Privateadd+- add
+-
+
+
+
+
Adds the given worker in the pool worker nodes.
+Parameters
++-
+
worker: Worker
+The worker.
+Returns number
The added worker node key.
+ +Throws
https://nodejs.org/api/errors.html#class-error If the added worker node is not found.
+Protectedafter-- after
+- after
-
-- Defined in src/pools/abstract-pool.ts:1035
+
+
-
-- Defined in src/pools/abstract-pool.ts:494
+
+
Hook executed after the worker task execution. Can be overridden.
@@ -335,39 +496,39 @@ Can be overridden.Parameters
-
-
-
-
-worker: Worker
-The worker.
+workerNodeKey: number
+The worker node key.
message: MessageValue<Response, unknown, Worker | MessagePort>
+message: MessageValue<Response, unknown>
The received message.
Returns void
+ProtectedAbstractafterProtectedafter-- after
+- after
-
-
- Defined in src/pools/abstract-pool.ts:1346
+- Defined in src/pools/abstract-pool.ts:1005
-- Defined in src/pools/abstract-pool.ts:600
+
+
-
-- Defined in src/pools/abstract-pool.ts:1571
+
+
-
-- Defined in src/pools/abstract-pool.ts:1559
+
+
-
-- Defined in src/pools/abstract-pool.ts:1565
+
+
+
Function 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
+maxListenersor binding themain-worker<->workerconnection if not bind by default.Method hooked up after a worker node has been newly created. +Can be overridden.
Parameters
-
-
+worker: Worker
-The newly created worker.
+workerNodeKey: number
+The newly created worker node key.
Returns void
Protectedbefore@@ -392,7 +553,7 @@ Can be overridden.
Returns void
Privatebuild@@ -405,80 +566,78 @@ Can be overridden.
tasksQueueOptions: TasksQueueOptions
Returns TasksQueueOptions
-
+PrivatecheckPrivatecheck-- check
+- check
-
Returns void
+PrivatecheckPrivatecheck-- check
+- check
-
-
-
Parameters
---
-
filePath: string
Returns void
+PrivatecheckPrivatecheck-- check
+- check
-
-
-
Parameters
---
-
numberOfWorkers: number
Returns void
+PrivatecheckPrivatecheck-- check
+- check
-
+
-
-
-
Checks if the worker id sent in the received message from a worker is valid.
+Parameters
opts: PoolOptions<Worker>
Returns void
Returns void
+Throws
https://nodejs.org/api/errors.html#class-error If the worker id is invalid.
+
+PrivatecheckPrivatecheck-- check
+- check
-
-
-
+
Parameters
tasksQueueOptions: TasksQueueOptions
numberOfWorkers: number
Returns void
+PrivatecheckPrivatecheck-- check
+- check
-
-
-
+
Parameters
workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
opts: PoolOptions<Worker>
Returns void
Privatecheck@@ -491,43 +650,69 @@ Can be overridden.
workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
Returns void
-Protectedchoose+- Defined in src/pools/abstract-pool.ts:217
+PrivatechooseChooses a worker node for the next task.
-The default worker choice strategy uses a round robin algorithm to distribute the load.
+The default worker choice strategy uses a round robin algorithm to distribute the tasks.
+Returns number
The chosen worker node key
+ +
+Protectedcreate+- create
+-
+
Creates a new, completely set up dynamic worker node.
Returns number
The worker node key
+Returns number
New, completely set up dynamic worker node key.
+ProtectedcreateProtectedcreate-- create
+- create
-
-
- Defined in src/pools/abstract-pool.ts:1208
- create
-
-
- Defined in src/pools/abstract-pool.ts:1201
+
+
+- Defined in src/pools/abstract-pool.ts:1661
+
+
- destroy(): Promise<void>
-
-
-- Defined in src/pools/abstract-pool.ts:940
+
+
-
Creates a new worker and sets it up completely in the pool worker nodes.
+Creates a new, completely set up worker node.
Returns Worker
New, completely set up worker.
+Returns number
New, completely set up worker node key.
+ProtectedAbstractcreateReturns a newly created worker.
+Creates a new worker.
Returns Worker
+Returns Worker
Newly created worker.
+ +
+Privatedelete+- delete
+-
+
+
+
Parameters
++-
+
name: string
Returns void
Privatedequeue@@ -540,63 +725,103 @@ Can be overridden.
workerNodeKey: number
Returns undefined | Task<Data>
+ProtectedAbstractderegister+- deregister
+-
+
+
+
+
+
Deregisters a listener callback on the worker given its worker node key.
+Type Parameters
++-
+
Message
Parameters
++-
+
+-
+
workerNodeKey: number
+The worker node key.
+listener: ((message) => void)
+The message listener callback.
++-
+
+- (message): void
+-
+
+
+
Parameters
++-
+
message: MessageValue<Message, unknown>
Returns void
Returns void
+destroy
Shutdowns every current worker in this pool.
+Terminates all workers in this pool.
Returns Promise<void>
-
+ProtectedAbstractdestroyProtectedAbstractdestroy-- destroy
+- destroy
-
-
- Defined in src/pools/abstract-pool.ts:981
- enable
-
-
- Defined in src/pools/abstract-pool.ts:1655
-
-
+
+- flush
-
@@ -665,7 +904,7 @@ Can be overridden.
+- Defined in src/pools/abstract-pool.ts:1669
-
-
+
+
+
-- Defined in src/pools/abstract-pool.ts:1585
+
+
-
-- Defined in src/pools/abstract-pool.ts:513
+
+
+- Defined in src/pools/abstract-pool.ts:525
+
+
+
+
+
+
+
+
+
+
+
+
- internal
-
-
+- Defined in src/pools/abstract-pool.ts:667
-
-- Defined in src/pools/abstract-pool.ts:996
+
+
+
+
+- Defined in src/pools/abstract-pool.ts:1307
+
+
+- Defined in src/pools/abstract-pool.ts:1618
+
+
+
+
+
+
+
+
+
+
+- Defined in src/pools/abstract-pool.ts:1109
- worker
-
-
- (message): void
-
-
-
-
+
- Defined in src/pools/abstract-pool.ts:1497
+
+
+
+
Shutdowns the given worker.
+Terminates the worker node given its worker node key.
Parameters
-
-
+worker: Worker
-A worker within
+workerNodes.workerNodeKey: number
+The worker node key.
Returns void | Promise<void>
+Returns Promise<void>
enable
Enables/disables the worker tasks queue in this pool.
+Enables/disables the worker node tasks queue in this pool.
Parameters
-
-
+- Defined in src/pools/abstract-pool.ts:565
+enable: boolean
-Whether to enable or disable the worker tasks queue.
+Whether to enable or disable the worker node tasks queue.
-OptionaltasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
+The worker node tasks queue options.
Returns void
Privateenqueue@@ -611,11 +836,11 @@ Can be overridden.
task: Task<Data>
Returns number
execute
-- execute(data?, name?): Promise<Response>
+- execute(data?, name?, transferList?): Promise<Response>
-
-
-
-
+
+- Defined in src/pools/abstract-pool.ts:870
- execute
-
+
-
-
+-
-
-
Executes the specified function in the worker constructor with the task data input parameter.
-Optionaldata: 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.
-Optionalname: 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.
+
+OptionaltransferList: 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.
Returns Promise<Response>
Promise that will be fulfilled when the task is completed.
@@ -637,25 +867,34 @@ Can be overridden.PrivateexecuteExecutes the given task on the worker given its worker node key.
+Parameters
workerNodeKey: number
workerNodeKey: number
+The worker node key.
+task: Task<Data>
Returns void
Returns void
+
-Privateflush+- Defined in src/pools/abstract-pool.ts:1649
+ProtectedflushworkerNodeKey: number
Returns void
Privateflush@@ -673,24 +912,31 @@ Can be overridden.-
Returns void
-Privateget-- get
+- Defined in src/pools/abstract-pool.ts:1679
+Protectedget+- get
-
+
-
-
-
Gets the worker information given its worker node key.
+Parameters
worker: Worker
Returns TaskStatistics
Returns WorkerInfo
The worker information.
+ + -
+PrivategetPrivateget-- get
+- get
-
Gets the given worker its worker node key.
The worker.
Returns number
The worker node key if the worker is found in the pool worker nodes,
+-1otherwise.Returns number
The worker node key if found in the pool worker nodes,
-1otherwise.
+PrivategetPrivateget-- get
+- get
-
+
-
-
-
Gets the worker node key given its worker id.
+Parameters
worker: Worker
Returns WorkerUsage
Returns number
The worker node key if the worker id is found in the pool worker nodes,
+ + +-1otherwise.
+Privatehandle+- handle
+-
+
+
+
Parameters
++-
+
message: MessageValue<Response, unknown>
Returns void
+Privatehandle+- handle
+-
+
+
+
Parameters
++-
+
message: MessageValue<Response, unknown>
Returns void
+Privatehas+- has
+-
+
Returns boolean
has
++- has
+-
+
+
+
Whether the specified task function exists in this pool.
+Parameters
++-
+
name: string
+The name of the task function.
+Returns boolean
+ +trueif the task function exists,falseotherwise.has
++- has
+
+
+
Internal+Whether the worker node has back pressure (i.e. its tasks queue is full).
+Parameters
++-
+
workerNodeKey: number
+The worker node key.
+Returns boolean
+ +trueif the worker node has back pressure,falseotherwise.
+Privateinitialize+- initialize
+-
+
Returns void
ProtectedinternalReturns boolean
ProtectedAbstractis@@ -738,33 +1079,79 @@ Can be overridden.
Returns boolean
+Privatepushlist
++- list
+-
+
Lists the names of task function available in this pool.
+Returns string[]
The names of task function available in this pool.
+ +Privateredistribute-- push
+- redistribute
-
-
+
+
+
+- Defined in src/pools/abstract-pool.ts:1320
Pushes the given worker in the pool worker nodes.
+Parameters
++-
+
workerNodeKey: number
Returns void
+
+ProtectedAbstractregister+- register
+-
+
+
-
-
+-
+
+
Registers once a listener callback on the worker given its worker node key.
Type Parameters
++-
+
Message
Parameters
worker: Worker
-The worker.
+workerNodeKey: number
+The worker node key.
Returns number
The worker nodes length.
- +listener: ((message) => void)
+The message listener callback.
++-
+
+- (message): void
+-
+
+
+
Parameters
++-
+
message: MessageValue<Message, unknown>
Returns void
Returns void
ProtectedAbstractregister-- register
+- register
-
-
-
-
-
@@ -793,12 +1180,33 @@ Can be overridden.
-
-
Registers a listener callback on the given worker.
+Registers a listener callback on the worker given its worker node key.
Type Parameters
@@ -775,8 +1162,8 @@ Can be overridden.Parameters
worker: Worker
-The worker which should register a listener.
+workerNodeKey: number
+The worker node key.
Parameters
message: MessageValue<Message, unknown, Worker | MessagePort>
message: MessageValue<Message, unknown>
Returns void
Returns void
remove
++- remove
+-
+
+
+
Removes a task function from this pool.
+Parameters
++-
+
name: string
+The name of the task function.
+Returns Promise<boolean>
+ +trueif the task function was removed,falseotherwise.Privateremove@@ -817,51 +1225,185 @@ Can be overridden.
Returns void
+Protectedsend+- send
+-
+
+
+
Parameters
++-
+
workerNodeKey: number
Returns Promise<void>
+ProtectedAbstractsend+- send
+-
+
+
+
Sends the startup message to worker given its worker node key.
+Parameters
++-
+
workerNodeKey: number
+The worker node key.
+Returns void
+
+Privatesend+- send
+-
+
+
+
Sends the statistics message to worker given its worker node key.
+Parameters
++-
+
workerNodeKey: number
+The worker node key.
+Returns void
+
+Privatesend+- send
+-
+
+
+
Parameters
++-
+
+-
+
workerNodeKey: number
message: MessageValue<Data, unknown>
Returns Promise<boolean>
+Privatesend+- send
+-
+
+
+
Parameters
++-
+
message: MessageValue<Data, unknown>
Returns Promise<boolean>
ProtectedAbstractsend-- send
+- send
-
-
- Defined in src/pools/abstract-pool.ts:1190
+
+
+
+
- set
-
-
- Defined in src/pools/abstract-pool.ts:579
+
+
+
+
+- Defined in src/pools/abstract-pool.ts:532
-
-- Defined in src/pools/abstract-pool.ts:551
+
+
+
+
- Defined in src/pools/abstract-pool.ts:1122
+
+
+
+
+- Defined in src/pools/abstract-pool.ts:1410
Sends a message to the given worker.
+Sends a message to worker given its worker node key.
Parameters
-
-
-
-
+-
+
+worker: Worker
-The worker which should receive the message.
+workerNodeKey: number
+The worker node key.
message: MessageValue<Data, unknown, Worker | MessagePort>
+message: MessageValue<Data, unknown>
The message.
+OptionaltransferList: TransferListItem[]The optional array of transferable objects.
+Returns void
set
++- set
+-
+
+
+
Sets the default task function in this pool.
+Parameters
++-
+
name: string
+The name of the task function.
+Returns Promise<boolean>
+ +trueif the default task function was set,falseotherwise.
+Privateset+- set
+-
+
Returns void
set
Sets the worker tasks queue options in this pool.
+Sets the worker node tasks queue options in this pool.
Parameters
-
+tasksQueueOptions: TasksQueueOptions
-The worker tasks queue options.
+The worker node tasks queue options.
Returns void
+Privateset+- set
+-
+
+
+
Parameters
++-
+
size: number
Returns void
+Privateset+- set
+-
+
Returns void
set
@@ -886,7 +1428,7 @@ Can be overridden.
set
@@ -906,56 +1448,89 @@ Can be overridden.
+Privateset
+Protectedsetup+- setup
+-
+
Setup hook to execute code before worker nodes are created in the abstract constructor. +Can be overridden.
+Returns void
+Privateshall-- set
+- shall
-
-
+
+- Defined in src/pools/abstract-pool.ts:1665
+
+
+
+
+
+
Sets the given worker node its tasks usage in the pool.
+Conditions for dynamic worker creation.
Returns boolean
Whether to create a dynamic worker or not.
+ + +
+Privateshall+- shall
+-
+
-
-
+- Defined in src/pools/abstract-pool.ts:1429
Parameters
-
-
+workerNode: WorkerNode<Worker, Data>
-The worker node.
+workerNodeKey: number
Returns boolean
+Privateshall+- shall
+-
+
+
+
+
-
-- Defined in src/pools/abstract-pool.ts:924
+
+
Whether the worker node shall update its task function worker usage or not.
Parameters
+-
-
+workerUsage: WorkerUsage
-The worker usage.
+workerNodeKey: number
+The worker node key.
Returns boolean
+ +trueif the worker node shall update its task function worker usage,falseotherwise.start
++- start(): void
+-
+
Starts the minimum number of workers in this pool.
+Returns void
+PrivatesetPrivatetask-- set
+- task
-
-
-
+
Parameters
worker: Worker
workerId: number
Returns void
-Protectedsetup-- setup
--
-
Setup hook to execute code before worker node are created in the abstract constructor. -Can be overridden
-Returns void
-Privatetasks@@ -968,7 +1543,36 @@ Can be overridden
workerNodeKey: number
Returns number
+Privatetasks+- tasks
+-
+
+
+
Parameters
++-
+
workerId: number
Returns void
+Privateunset+- unset
+-
+
Returns void
+Privateunset+- unset
+-
+
Returns void
Privateupdate@@ -980,10 +1584,10 @@ Can be overridden-
-
-
workerUsage: WorkerUsage
message: MessageValue<Response, unknown, Worker | MessagePort>
message: MessageValue<Response, unknown>
Returns void
+Privateupdate@@ -995,10 +1599,40 @@ Can be overridden-
-
-
workerUsage: WorkerUsage
message: MessageValue<Response, unknown, Worker | MessagePort>
message: MessageValue<Response, unknown>
Returns void
+
+Privateupdate+- update
+-
+
+
+
Parameters
++-
+
+-
+
workerUsage: WorkerUsage
message: MessageValue<Response, unknown>
Returns void
+Privateupdate+- update
+-
+
+
Parameters
++-
+
+-
+
workerNodeKey: number
taskName: string
Returns void
Privateupdate@@ -1013,13 +1647,13 @@ Can be overridden
task: Task<Data>
Returns void
ProtectedworkerThis function is the listener registered for each worker message.
+This method is the listener registered for each worker message.
Returns ((message) => void)
The listener function to execute when a message is received from a worker.
@@ -1028,32 +1662,32 @@ Can be overriddenThis function is the listener registered for each worker message.
+This method is the listener registered for each worker message.
Parameters
message: MessageValue<Response, unknown, Worker | MessagePort>
message: MessageValue<Response, unknown>
Returns void
The listener function to execute when a message is received from a worker.
-
+Settings
Settings
Member Visibility
Theme
@@ -1063,9 +1697,14 @@ Can be overridden- constructor
- emitter
- file
+- max
- number
- opts
- promise
+- start
+- started
+- starting
+- task
- worker
- worker
- busy
@@ -1073,112 +1712,109 @@ Can be overridden
- info
- max
- min
+- ready
- type
+- utilization
- worker
+- add
+- add
- after
-- after
+- after
- before
- build
-- check
-- check
+- check
+- check
+- check
+- check
- check
- check
-- check
-- check
- check
-- choose
-- create
+- choose
+- create
+- create
- create
+- delete
- dequeue
+- deregister
- destroy
-- destroy
+- destroy
- enable
- enqueue
- execute
- execute
-- flush
+- flush
- flush
-- get
-- get
-- get
+- get
+- get
+- get
+- handle
+- handle
+- has
+- has
+- has
+- initialize
- internal
- is
-- push
+- list
+- redistribute
+- register
- register
+- remove
- remove
+- send
+- send
+- send
+- send
+- send
- send
+- set
+- set
- set
+- set
+- set
- set
- set
-- set
-- set
- setup
+- shall
+- shall
+- shall
+- start
+- task
- tasks
+- tasks
+- unset
+- unset
- update
- update
+- update
+- update
- update
- worker
Generated using TypeDoc
Generated using TypeDoc