Executes the specified function in the worker constructor with the task data input parameter.
@@ -639,12 +799,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
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).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.
+Protectedworker
-Readonlyworker
+ReadonlyInternalworkerPool worker nodes.
Accessors
Returns boolean
Protectedfull@@ -265,7 +328,7 @@
Returns boolean
info
@@ -277,58 +340,103 @@
+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:543
+
+- Defined in src/pools/abstract-pool.ts:169
Gets the worker type.
+The worker type.
Returns "cluster" | "thread"
+Returns "thread" | "cluster"
+Methods
+
+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:935
+
+
+- Defined in src/pools/abstract-pool.ts:156
+
+
Hook executed after the worker task execution. Can be overridden.
@@ -337,39 +445,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:1209
+- Defined in src/pools/abstract-pool.ts:905
-- Defined in src/pools/abstract-pool.ts:671
+
+
+
+
+- Defined in src/pools/abstract-pool.ts:1432
+
+
+
+
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@@ -394,7 +502,7 @@ Can be overridden.
Returns void
Privatebuild@@ -407,15 +515,46 @@ Can be overridden.
tasksQueueOptions: TasksQueueOptions
Returns TasksQueueOptions
-
+Privatecheck
+Privatecheck+- check
+-
+
Returns void
Privatecheck-- check
+- check
-
Returns void
+Privatecheck+- check
+-
+
Returns void
+Protectedcheck+- check
+-
+
+
+
Parameters
++-
+
+-
+
min: number
max: number
Returns void
Privatecheck@@ -428,7 +567,28 @@ Can be overridden.
filePath: string
Returns void
+Privatecheck+- check
+-
+
+
+
+
Checks if the worker id sent in the received message from a worker is valid.
+Parameters
++-
+
message: MessageValue<Response, unknown>
+The received message.
+Returns void
+Throws
https://nodejs.org/api/errors.html#class-error If the worker id is invalid.
+Privatecheck@@ -441,7 +601,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
Privatecheck@@ -454,7 +614,7 @@ Can be overridden.
opts: PoolOptions<Worker>
Returns void
Privatecheck@@ -467,7 +627,7 @@ Can be overridden.
tasksQueueOptions: TasksQueueOptions
Returns void
Privatecheck@@ -480,7 +640,7 @@ Can be overridden.
workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
Returns void
Privatecheck@@ -493,7 +653,7 @@ Can be overridden.
workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
Returns void
Privatechoose@@ -502,35 +662,35 @@ Can be overridden.
Chooses a worker node for the next task.
The default worker choice strategy uses a round robin algorithm to distribute the tasks.
Returns number
The worker node key
+Returns number
The chosen worker node key
+ProtectedcreateProtectedcreate-- create
+- create
-
-
-- Defined in src/pools/abstract-pool.ts:1152
+
+
+- Defined in src/pools/abstract-pool.ts:1534
- destroy(): Promise<void>
-
-
-- Defined in src/pools/abstract-pool.ts:850
+
+
+- Defined in src/pools/abstract-pool.ts:995
Creates a new dynamic worker and sets it up completely in the pool worker nodes.
+Creates a new, completely set up dynamic worker node.
Returns Worker
New, completely set up dynamic worker.
+Returns number
New, completely set up dynamic worker node key.
-
+ProtectedcreateProtectedcreate-- create
+- create
-
-
- Defined in src/pools/abstract-pool.ts:1108
+- Defined in src/pools/abstract-pool.ts:1101
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.
+ProtectedAbstractcreate@@ -542,7 +702,7 @@ Can be overridden.
Privatedequeue@@ -555,63 +715,63 @@ Can be overridden.
workerNodeKey: number
Returns undefined | Task<Data>
destroy
Terminate 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:881
- enable
-
-
- Defined in src/pools/abstract-pool.ts:1528
-
-
+
+- flush
-
@@ -680,7 +854,7 @@ Can be overridden.
+- Defined in src/pools/abstract-pool.ts:1542
-
-
+
+
+
-- Defined in src/pools/abstract-pool.ts:1458
+
+
-
-- Defined in src/pools/abstract-pool.ts:584
+
+
+- Defined in src/pools/abstract-pool.ts:596
+
+
+
+
+
+
+
+
- internal
-
-
- Defined in src/pools/abstract-pool.ts:738
-
-
+
+
+- Defined in src/pools/abstract-pool.ts:1253
+- Defined in src/pools/abstract-pool.ts:1196
+- Defined in src/pools/abstract-pool.ts:1491
+
+
+
+
+
+
Terminates 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:636
+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@@ -626,11 +786,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:779
- 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.
@@ -652,25 +817,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:1522
+ProtectedflushworkerNodeKey: number
Returns void
Privateflush@@ -688,24 +862,31 @@ Can be overridden.-
Returns void
-Privateget-- get
+- Defined in src/pools/abstract-pool.ts:1552
+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
+
+
+
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.ProtectedinternalWhether worker nodes are executing at least one task.
+Whether worker nodes are executing concurrently their tasks quota or not.
Returns boolean
Worker nodes busyness boolean status.
+ProtectedAbstractis@@ -757,33 +1000,39 @@ Can be overridden.
Returns boolean
-Privatepush-- push
+- Defined in src/pools/abstract-pool.ts:896
list
++- list
-
-
+
Pushes the given worker in the pool worker nodes.
+Lists the names of task function available in this pool.
Returns string[]
The names of task function available in this pool.
+ + +
+Privateredistribute+- redistribute
+-
-
-
-
Parameters
worker: Worker
-The worker.
-Returns number
The worker nodes length.
- -Returns void
ProtectedAbstractregister-- register
+- register
-
-
-
-
-
@@ -812,12 +1061,12 @@ 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
@@ -794,8 +1043,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
Privateremove@@ -836,51 +1085,138 @@ Can be overridden.
Returns void
+Protectedsend+- send
+-
+
+
+
Parameters
++-
+
+-
+
workerNodeKey: number
workerId: 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
+ProtectedAbstractsend-- send
+- send
-
-
- Defined in src/pools/abstract-pool.ts:1090
+
+
- set
-
-
- Defined in src/pools/abstract-pool.ts:650
+
+
+
+
+- Defined in src/pools/abstract-pool.ts:603
-
-- Defined in src/pools/abstract-pool.ts:622
+
+
+
+
-
-- Defined in src/pools/abstract-pool.ts:770
+
+
+
-
+
+
+- Defined in src/pools/abstract-pool.ts:1538
+
+
+
+
+
+
- Defined in src/pools/abstract-pool.ts:1022
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
+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
@@ -905,7 +1241,7 @@ Can be overridden.
set
@@ -925,68 +1261,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
-
-
+
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
+-
-
-
--
-
-
Parameters
workerNode: WorkerNode<Worker, Data>
-The worker node.
-workerUsage: WorkerUsage
-The worker usage.
-Returns void
-Returns boolean
+PrivatesetPrivateshall-- set
+- shall
-
+
-
-
-
Whether the worker node shall update its task function worker usage or not.
+Parameters
worker: Worker
Returns void
Returns boolean
+ + -trueif the worker node shall update its task function worker usage,falseotherwise.
-Protectedsetup-- setup
+- Defined in src/pools/abstract-pool.ts:968
start
++- start(): void
-
-
-- Defined in src/pools/abstract-pool.ts:834
+
+
+- Defined in src/pools/abstract-pool.ts:1297
Setup hook to execute code before worker node are created in the abstract constructor. -Can be overridden
+Starts the minimum number of workers in this pool.
Returns void
-
+PrivateshallPrivatetask-- shall
+- task
-
-
Conditions for dynamic worker creation.
-Returns boolean
Whether to create a dynamic worker or not.
- -Privatetasks@@ -999,7 +1356,36 @@ Can be overridden
workerNodeKey: number
Returns number
+Privatetasks+- tasks
+-
+
+
+
Parameters
++-
+
workerId: number
Returns void
+Privateunset+- unset
+-
+
Returns void
+Privateunset+- unset
+-
+
Returns void
Privateupdate@@ -1011,10 +1397,10 @@ Can be overridden-
-
-
workerUsage: WorkerUsage
message: MessageValue<Response, unknown, Worker | MessagePort>
message: MessageValue<Response, unknown>
Returns void
+Privateupdate@@ -1026,10 +1412,10 @@ Can be overridden-
-
-
workerUsage: WorkerUsage
message: MessageValue<Response, unknown, Worker | MessagePort>
message: MessageValue<Response, unknown>
Returns void
Privateupdate@@ -1041,10 +1427,25 @@ Can be overridden-
-
-
workerUsage: WorkerUsage
message: MessageValue<Response, unknown, Worker | MessagePort>
message: MessageValue<Response, unknown>
Returns void
+Privateupdate+- update
+-
+
+
Parameters
++-
+
+-
+
workerNodeKey: number
taskName: string
Returns void
Privateupdate@@ -1059,13 +1460,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.
@@ -1074,32 +1475,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
@@ -1109,9 +1510,13 @@ Can be overriddenconstructor
emitter
file
+max
number
opts
promise
+start
+started
+starting
worker
worker
busy
@@ -1119,115 +1524,103 @@ Can be overridden
info
max
min
+ready
type
+utilization
worker
+add
after
-after
+after
before
build
-check
+check
+check
+check
+check
check
+check
check
check
check
check
check
choose
-create
-create
+create
+create
create
dequeue
destroy
-destroy
+destroy
enable
enqueue
execute
execute
-flush
+flush
flush
-get
-get
-get
+get
+get
+get
+handle
+handle
+has
+has
internal
is
-push
+list
+redistribute
register
remove
+send
+send
+send
send
+set
set
+set
+set
set
set
-set
-set
setup
shall
+shall
+shall
+start
+task
tasks
+tasks
+unset
+unset
update
update
update
+update
update
worker