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:
'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).
Emitter 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:
'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).ProtectedReadonlyfileProtectedOptionalReadonlymaxProtectedReadonlynumberProtectedReadonlyoptsProtectedpromiseThe task 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.ProtectedworkerReadonlyInternalworkerAccessors
Protectedfull@@ -262,7 +270,7 @@
info
@@ -274,7 +282,7 @@
Protectedmax@@ -286,7 +294,7 @@
Protectedmin@@ -298,7 +306,7 @@
Privateready@@ -310,7 +318,7 @@
Protectedtype@@ -323,7 +331,7 @@
Privateutilization@@ -336,7 +344,7 @@
Protectedworker@@ -348,9 +356,40 @@
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.Protectedafter@@ -376,7 +415,7 @@ Can be overridden.
Protectedafter@@ -397,7 +436,7 @@ Can be overridden.
Protectedbefore@@ -423,23 +462,7 @@ Can be overridden.
-Protectedcheck-- check
--
-
-
-
Parameters
---
-
--
-
min: number
max: number
Returns void
Protectedcreate@@ -452,7 +475,7 @@ Can be overridden.
Protectedcreate@@ -465,7 +488,7 @@ Can be overridden.
Protectedcreate@@ -478,7 +501,48 @@ Can be overridden.
+Protectedderegister+- 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
@@ -490,7 +554,7 @@ Can be overridden.
Protecteddestroy@@ -510,7 +574,7 @@ Can be overridden.
enable
@@ -535,7 +599,7 @@ Can be overridden.
execute
@@ -566,7 +630,21 @@ Can be overridden.
+Protectedflag+- flag
+-
+
+
+
Parameters
++-
+
workerNodeKey: number
Returns void
Protectedflush@@ -580,11 +658,11 @@ Can be overridden.
Returns void
Protectedget-- get
+- get
-
Gets the worker information given its worker node key.
The worker node key.
Returns undefined | WorkerInfo
The worker information.
+Returns WorkerInfo
The worker information.
+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
@@ -622,7 +721,7 @@ Can be overridden.
Protectedinternal@@ -635,7 +734,7 @@ Can be overridden.
Protectedis@@ -647,20 +746,61 @@ Can be overridden.
list
+list
-- 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 once 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
+Protectedregister@@ -701,23 +841,42 @@ Can be overridden.
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.Protectedsend-- send
+- send
-
-
-
--
-
+
Parameters
workerNodeKey: number
workerId: number
workerNodeKey: number
Returns Promise<void>
Protectedsend@@ -737,7 +896,7 @@ Can be overridden.
Protectedsend@@ -762,7 +921,28 @@ Can be overridden.
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.set
@@ -782,7 +962,7 @@ Can be overridden.
set
@@ -807,7 +987,7 @@ Can be overridden.
set
@@ -827,7 +1007,7 @@ Can be overridden.
Protectedsetup@@ -840,40 +1020,41 @@ Can be overridden.
-Protectedworker-- worker
+- Defined in src/pools/cluster/fixed.ts:53
start
++- start(): void
-
-
+
+- start
+- worker
-
This method is the listener registered for each worker message.
+Starts the minimum number of workers in this pool.
Returns ((message) => void)
The listener function to execute when a message is received from a worker.
- ---
-
+-- (message): void
+
Returns void
+
+Protectedworker+- worker
-
-
-
- - Defined in src/pools/abstract-pool.ts:1518
This method is the listener registered for each worker message.
+This method is the message listener registered on each worker.
Parameters
message: MessageValue<Response, unknown>
Returns void
The listener function to execute when a message is received from a worker.
- - +Returns void
-
+Settings
Settings
Member Visibility