2.0.0
-Protected workerReadonly workerProtected fullWhether the pool is full or not.
The pool filling boolean status.
Private numberProtected maxNumber of tasks queued in the pool.
+Pool maximum size.
Private numberProtected minNumber of tasks running in the pool.
+Pool minimum size.
Protected typePool type.
If it is 'dynamic', it provides the max property.
Protected workerGets the worker type.
+The worker.
The received message.
Protected afterProtected beforeProtected chooseChooses a worker node for the next task.
-The default uses a round robin algorithm to distribute the load.
- -[worker node key, worker node].
+The default worker choice strategy uses a round robin algorithm to distribute the load.
Protected createProtected createProtected destroyExecutes the function specified in the worker constructor with the task data input parameter.
- -Promise that will be fulfilled when the task is completed.
+Executes the specified function in the worker constructor with the task data input parameter.
Optional data: DataThe task input data for the specified worker function. This can only be serializable data.
+Optional name: stringThe name of the worker function to execute. If not specified, the default worker function will be executed.
Protected internalProtected isProtected registerRegisters a listener callback on the given worker.
Protected sendThe worker which should receive the message.
The message.
The worker choice strategy.
Protected setupProtected workerThis function is the listener registered for each worker message.
- -The listener function to execute when a message is received from a worker.
The listener function to execute when a message is received from a worker.
+This function is the listener registered for each worker message.
- -The listener function to execute when a message is received from a worker.
The listener function to execute when a message is received from a worker.
+Generated using TypeDoc
Type of data sent to the worker. This can only be serializable data.
@@ -42,7 +42,7 @@ When the maximum number of workers is reached and workers are busy, an event is- DynamicClusterPool
+@@ -55,10 +55,10 @@ When the maximum number of workers is reached and workers are busy, an event is
emitter?
-file
busy
-full
-number
-
+
+ - Defined in src/pools/cluster/dynamic.ts:27
@@ -142,42 +144,44 @@ When the maximum number of workers is reached and workers are busy, an event is
-
-- Defined in src/pools/abstract-pool.ts:47
+
+
file
-
-- Defined in src/pools/abstract-pool.ts:82
+
+
max: number
-
-- Defined in src/pools/cluster/dynamic.ts:29
+
+
number
-
-- Defined in src/pools/abstract-pool.ts:81
+
+
opts: ClusterPoolOptions = {}
+- Defined in src/pools/cluster/fixed.ts:57
Properties
Accessors
Methods
@@ -102,9 +104,9 @@ When the maximum number of workers is reached and workers are busy, an event isConstructs a new poolifier dynamic cluster pool.
Type Parameters
-+-
-
@@ -131,7 +133,7 @@ When the maximum number of workers is reached and workers are busy, an event is
Data = unknown
Returns DynamicClusterPool<Data, Response>
Properties
'full': Emitted when the pool is dynamic and full.'busy': Emitted when the pool is busy.'error': Emitted when an uncaught error occurs.'taskError': Emitted when an error occurs while executing a task.
+ReadonlyfileProtectedReadonlyfilePath to the worker file.
+ReadonlymaxProtectedReadonlymaxMaximum number of workers that can be created by this pool.
+ReadonlynumberProtectedReadonlynumberNumber of workers that this pool should manage.
+ReadonlyoptsProtectedReadonlyoptsOptions for this fixed cluster pool.
Protectedpromise