Executes the specified function in the worker constructor with the task data input parameter.
@@ -484,12 +535,17 @@ Can be overridden.
Optionaldata: Data
-
The task input data for the specified worker 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.
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.
Emitter on which events can be listened to.
Events that can currently be listened to:
-
@@ -152,7 +162,7 @@ +'full': Emitted when the pool is dynamic and full.'busy': Emitted when the pool is busy.'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.'error': Emitted when an uncaught error occurs.'taskError': Emitted when an error occurs while executing a task.ProtectedReadonlyfileProtectedReadonlynumberProtectedReadonlyopts
-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.Protectedworker
-ReadonlyworkerPool worker nodes.
Accessors
Protectedfull@@ -239,7 +249,7 @@
info
@@ -251,62 +261,87 @@
ProtectedmaxPool 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/thread/fixed.ts:127
Gets the worker type.
+The worker type.
Returns "cluster" | "thread"
+Returns "thread" | "cluster"
+Methods
Protectedafter-- after
+- after
-
-
-
-
@@ -328,28 +363,28 @@ Can be overridden.
-
-- Defined in src/pools/abstract-pool.ts:792
+
+
Hook executed after the worker task execution. Can be overridden.
@@ -315,8 +350,8 @@ Can be overridden.Parameters
worker: Worker
-The worker.
+workerNodeKey: number
+The worker node key.
+ProtectedafterProtectedafter-- after
+- after
-
-
- Defined in src/pools/abstract-pool.ts:1025
-
-- Defined in src/pools/abstract-pool.ts:771
+
+
Function that can be hooked up when a worker has been newly created and moved to the pool worker nodes. +
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@@ -375,33 +410,49 @@ Can be overridden.
+ProtectedcreateProtectedcheck-- create
+- check
-
-
+
+
+
-
-- Defined in src/pools/abstract-pool.ts:972
+
+
Creates a new dynamic worker and sets it up completely in the pool worker nodes.
+Parameters
++-
+
+-
+
min: number
max: number
Returns void
+
+Protectedcreate+- create
+-
+
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:932
+- Defined in src/pools/thread/fixed.ts:114
- destroy(): Promise<void>
-
-
-- Defined in src/pools/abstract-pool.ts:718
+
+
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.
+Protectedcreate@@ -414,39 +465,39 @@ Can be overridden.
destroy
Terminate every current worker in this pool.
+Terminates all workers in this pool.
Returns Promise<void>
-
+ProtecteddestroyProtecteddestroy-- destroy
+- destroy
-
-
- Defined in src/pools/thread/fixed.ts:60
+- Defined in src/pools/abstract-pool.ts:578
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 Promise<void>
enable
@@ -471,11 +522,11 @@ Can be overridden.
execute
-- execute(data?, name?): Promise<Response>
+- execute(data?, name?, transferList?): Promise<Response>
-
-
-
-
+
+- Defined in src/pools/abstract-pool.ts:659
+
+
+
+
- internal
-
-
- Defined in src/pools/abstract-pool.ts:629
+- Defined in src/pools/thread/fixed.ts:55
+
+
+
+
+
+
+
+
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 structured-cloneable 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.
@@ -497,20 +553,55 @@ 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.
+ +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.
+Protectedis@@ -522,32 +613,127 @@ 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
+-
+
+
+
+
+
Registers 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
+
+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/thread/fixed.ts:77
+- Defined in src/pools/abstract-pool.ts:590
+- Defined in src/pools/abstract-pool.ts:548
+- Defined in src/pools/abstract-pool.ts:567
+- Defined in src/pools/abstract-pool.ts:755
- worker
-
-
- (message): void
-
-
+- Defined in src/pools/abstract-pool.ts:1108
@@ -686,20 +872,29 @@ Can be overridden.
- info
- max
- min
+- ready
- type
+- utilization
- worker
- after
-- after
+- after
- before
-- create
-- create
+- check
+- create
+- create
- create
- destroy
-- destroy
+- destroy
- enable
- execute
+- flush
+- get
- internal
- is
+- list
+- register
+- send
+- send
- send
- set
- set
@@ -707,7 +902,7 @@ Can be overridden.
- setup
- worker
-
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>
The message.
+OptionaltransferList: TransferListItem[]The optional array of transferable objects.
+Returns void
set
@@ -567,7 +753,7 @@ Can be overridden.
set
@@ -592,7 +778,7 @@ Can be overridden.
set
@@ -612,7 +798,7 @@ Can be overridden.
Protectedsetup@@ -625,13 +811,13 @@ Can be overridden.
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.
@@ -640,7 +826,7 @@ Can be overridden.This function is the listener registered for each worker message.
+This method is the listener registered for each worker message.
Parameters
@@ -653,7 +839,7 @@ Can be overridden.