Executes the specified function in the worker constructor with the task data input parameter.
@@ -495,12 +553,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.
@@ -59,7 +59,7 @@ When the maximum number of workers is reached and workers are busy, an event isemitter?
filebusy
full
info
-max
after- Defined in src/pools/cluster/dynamic.ts:27
@@ -150,16 +159,19 @@ When the maximum number of workers is reached and workers are busy, an event is
+- Defined in src/pools/abstract-pool.ts:65
file
@@ -168,15 +180,16 @@ When the maximum number of workers is reached and workers are busy, an event is
-
+- Defined in src/pools/abstract-pool.ts:110
+
max: number
+- Defined in src/pools/cluster/dynamic.ts:29
number
@@ -185,7 +198,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+- Defined in src/pools/abstract-pool.ts:109
opts: ClusterPoolOptions = {}
@@ -194,11 +207,11 @@ When the maximum number of workers is reached and workers are busy, an event is
+- Defined in src/pools/cluster/fixed.ts:47
promise
-promise
+- Defined in src/pools/abstract-pool.ts:75
worker
+- Defined in src/pools/abstract-pool.ts:81
-worker
+worker
+- Defined in src/pools/abstract-pool.ts:62
@@ -242,7 +254,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+- Defined in src/pools/cluster/dynamic.ts:43
+- Defined in src/pools/abstract-pool.ts:641
-
+- Defined in src/pools/abstract-pool.ts:324
+
Properties
Methods
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 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).ProtectedReadonlyfileProtectedReadonlymaxMaximum number of workers that can be created by this pool.
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.ProtectedworkerWorker choice strategy context referencing a worker choice algorithm implementation.
-Default to a round robin algorithm.
-Readonlyworker
+ReadonlyInternalworkerPool worker nodes.
Accessors
Protectedfull@@ -255,7 +267,7 @@ When the maximum number of workers is reached and workers are busy, an event is
info
@@ -267,62 +279,87 @@ When the maximum number of workers is reached and workers are busy, an event is
-Protectedmax+- get maxSize(): number
-
-
- Defined in src/pools/abstract-pool.ts:525
- get minSize(): number
-
-
- Defined in src/pools/abstract-pool.ts:518
+
+
- get type(): "fixed" | "dynamic"
-
-
- Defined in src/pools/cluster/dynamic.ts:38
+
+
Pool maximum size.
+The pool maximum size.
Returns number
+ProtectedminPool minimum size.
+The pool minimum size.
Returns number
+
+Privateready+- get ready(): boolean
+-
+
The pool readiness boolean status.
+Returns boolean
+ProtectedtypePool 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.
+ +Protectedworker-- get worker(): "cluster" | "thread"
+- get worker(): "thread" | "cluster"
-
-
- Defined in src/pools/cluster/fixed.ts:115
Gets the worker type.
+The worker type.
Returns "cluster" | "thread"
+Returns "thread" | "cluster"
+Methods
Protectedafter-- after
+- after
-
-- Defined in src/pools/abstract-pool.ts:827
+
+
Hook executed after the worker task execution. Can be overridden.
@@ -331,12 +368,12 @@ Can be overridden.Parameters
-
-
-
-
-worker: Worker
-The worker.
+workerNodeKey: number
+The worker node key.
message: MessageValue<Response, Worker | MessagePort>
+message: MessageValue<Response, unknown>
The received message.
+ProtectedafterProtectedafter-- after
+- after
-
-
- Defined in src/pools/abstract-pool.ts:1091
-
-- Defined in src/pools/abstract-pool.ts:804
+
+
+
+
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-- before
+- before
-
-
+
Hook executed before the worker task execution. Can be overridden.
@@ -381,83 +418,104 @@ Can be overridden.workerNodeKey: number
The worker node key.
task: Task<Data>
+The task to execute.
+Returns void
+Protectedchoose
+Protectedcheck+- check
+-
+
+
+
Parameters
++-
+
+-
+
min: number
max: number
Returns void
Protectedcreate-- choose
+- create
-
-
-- Defined in src/pools/abstract-pool.ts:1037
+
+
Chooses a worker node for the next task.
-The default worker choice strategy uses a round robin algorithm to distribute the load.
+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:997
- create
-
-
- Defined in src/pools/cluster/fixed.ts:105
- destroy(): Promise<void>
-
-
-- Defined in src/pools/abstract-pool.ts:750
+
+
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.
+ProtectedcreateReturns a newly created worker.
+Creates a new worker.
Returns Worker
+Returns Worker
Newly created worker.
+ +destroy
Shutdowns every current worker in this pool.
+Terminates all workers in this pool.
Returns Promise<void>
-
+ProtecteddestroyProtecteddestroy-- destroy
+- destroy
-
-
- Defined in src/pools/cluster/fixed.ts:63
+- Defined in src/pools/abstract-pool.ts:606
+- Defined in src/pools/cluster/fixed.ts:97
+
+
+
+
\ No newline at end of file
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
+Returns Promise<void>
enable
@@ -482,11 +540,11 @@ Can be overridden.
execute
-- execute(data?, name?): Promise<Response>
+- execute(data?, name?, transferList?): Promise<Response>
-
-
-
-
+
+- Defined in src/pools/abstract-pool.ts:691
+
+
+
+
+
+
- internal
-
-
+- Defined in src/pools/abstract-pool.ts:657
+- Defined in src/pools/cluster/fixed.ts:58
+
+
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.
@@ -508,16 +571,76 @@ Can be overridden.
+Protectedflush+- flush
+-
+
+
+
Parameters
++-
+
workerNodeKey: number
Returns void
+Protectedget+- get
+-
+
+
+
Gets the worker information given its worker node key.
+Parameters
++-
+
workerNodeKey: number
+The worker node key.
+Returns WorkerInfo
The worker information.
+ +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.ProtectedinternalReturns boolean
Protectedis@@ -529,13 +652,26 @@ Can be overridden.
list
++- list
+-
+
Lists the names of task function available in this pool.
+Returns string[]
The names of task function available in this pool.
+ +Protectedregister-- register
+- register
-
-
-
-
-
@@ -564,30 +700,66 @@ 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
@@ -546,8 +682,8 @@ Can be overridden.Parameters
worker: Worker
-The worker which should register a listener.
+workerNodeKey: number
+The worker node key.
Parameters
message: MessageValue<Message, Worker | MessagePort>
message: MessageValue<Message, unknown>
Returns void
Returns void
+Protectedsend+- send
+-
+
+
+
Parameters
++-
+
+-
+
workerNodeKey: number
workerId: number
Returns Promise<void>
+Protectedsend+- send
+-
+
+
+
Sends the startup message to worker given its worker node key.
+Parameters
++-
+
workerNodeKey: number
+The worker node key.
+Returns void
+Protectedsend-- send
+- send
-
-
- Defined in src/pools/cluster/fixed.ts:81
+- Defined in src/pools/abstract-pool.ts:618
+- Defined in src/pools/abstract-pool.ts:573
+- Defined in src/pools/abstract-pool.ts:592
- setup
-
-
- Defined in src/pools/cluster/fixed.ts:53
- worker
-
-
- (message): void
-
-
-
-
+
- Defined in src/pools/abstract-pool.ts:1174
@@ -724,7 +896,7 @@ Can be overridden
- constructor
- emitter
- file
-- max
+- max
- number
- opts
- promise
@@ -733,23 +905,32 @@ Can be overridden
- busy
- full
- info
-- max
+- max
- min
+- ready
- type
+- utilization
- worker
- after
-- after
+- after
- before
-- choose
-- create
+- check
+- create
+- create
- create
- destroy
-- destroy
+- destroy
- enable
- execute
+- flush
+- get
+- has
- internal
- is
+- list
- register
+- send
+- send
- send
- set
- set
@@ -757,7 +938,7 @@ Can be overridden
- setup
- worker
-
+- Worker
+- available
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, Worker | MessagePort>
+message: MessageValue<Data, unknown>
The message.
set
@@ -615,7 +787,7 @@ Can be overridden.
set
@@ -627,7 +799,7 @@ Can be overridden.-
-
@@ -640,7 +812,7 @@ Can be overridden.
Parameters
workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
+workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
The worker choice strategy.
set
@@ -660,26 +832,26 @@ Can be overridden.
ProtectedsetupSetup 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.
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.
@@ -688,20 +860,20 @@ 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, Worker | MessagePort>
message: MessageValue<Response, unknown>
Returns void
The listener function to execute when a message is received from a worker.
Generated using TypeDoc