Constructs a new poolifier pool.
Path to the worker file.
Options for the pool.
Optional Readonly emitterEmitter on which events can be listened to.
Events that can currently be listened to:
Readonly filePath to the worker file.
Readonly numberNumber of workers that this pool should manage.
Readonly optsOptions for the pool.
Protected promiseThe execution response promise map.
key: The message id of each submitted task.When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id.
Protected workerWorker choice strategy context referencing a worker choice algorithm implementation.
Default to a round robin algorithm.
Readonly workerPool worker nodes.
Protected Abstract fullPrivate numberPrivate numberAbstract typeProtected afterHook executed after the worker task execution. Can be overridden.
@@ -290,16 +290,16 @@ Can be overridden.The worker.
The received message.
Protected Abstract afterFunction 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 maxListeners or binding the main-worker<->worker connection if not bind by default.
Protected beforeHook executed before the worker task execution. Can be overridden.
@@ -331,32 +331,32 @@ Can be overridden.Private buildPrivate checkPrivate checkPrivate checkPrivate checkPrivate checkPrivate checkProtected chooseChooses a worker node for the next task.
The default uses a round robin algorithm to distribute the load.
[worker node key, worker node].
Protected createProtected Abstract createPrivate dequeueProtected Abstract destroyShutdowns the given worker.
Enables/disables the worker tasks queue in this pool.
Whether to enable or disable the worker tasks queue.
Optional tasksQueueOptions: TasksQueueOptionsOptional tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
Private enqueueExecutes the function specified in the worker constructor with the task data input parameter.
@@ -550,11 +550,11 @@ Can be overridden.Private executeFinds a free worker node key based on the number of tasks the worker has applied.
If a worker is found with 0 running tasks, it is detected as free and its worker node key is returned.
Private flushPrivate flushPrivate flushPrivate getPrivate getGets the given worker its tasks usage in the pool.
@@ -652,31 +652,31 @@ Can be overridden.The worker.
Protected internalProtected Abstract isPrivate pushPushes the given worker in the pool worker nodes.
@@ -691,11 +691,11 @@ Can be overridden.Protected Abstract registerRegisters a listener callback on the given worker.
Private removeRemoves the given worker from the pool worker nodes.
Protected Abstract sendSends a message to the given worker.
The worker which should receive the message.
The message.
Sets the worker tasks queue options in this pool.
The worker tasks queue options.
Sets the worker choice strategy in this pool.
The worker choice strategy.
Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsOptional workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
Sets the worker choice strategy options in this pool.
The worker choice strategy options.
Private setSets the given worker in the pool worker nodes.
The worker.
The worker tasks usage.
The worker task queue.
Private setSets the given worker node its tasks usage in the pool.
The worker node.
The worker node tasks usage.
Protected setupPrivate tasksProtected workerThis function is the listener registered for each worker message.
@@ -922,10 +922,10 @@ Can be overriddenProtected messageWorker message listener.
Message received.
Function processed by the worker when the pool's execution function is invoked.
Protected runRuns the given function synchronously.
Function that will be executed.
Input data for the given function.
Protected runRuns the given function asynchronously.
Function that will be executed.
Input data for the given function.
Call the provided function with the provided arguments in the execution context of the async resource. This will establish the context, trigger the AsyncHooks @@ -406,7 +406,7 @@ then restore the original execution context.
Protected Abstract sendSends a message to the main worker.
The response message.
The same triggerAsyncId that is passed to the AsyncResource constructor.
Static bindBinds the given function to the current execution context.
The returned function will have an asyncResource property referencing
@@ -463,7 +463,7 @@ the AsyncResource to which the function is bound.
Optional thisArg: ThisArgRest ...items: T[]Readonly [unscopables]Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.
Optional Readonly [unscopables]?: booleanOptional Readonly [unscopables]?: booleanIs an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.
Optional length?: booleanOptional length?: booleanGets or sets the length of the array. This is a number one higher than the highest index in the array.
Gets or sets the length of the array. This is a number one higher than the highest index in the array.
Static Readonly [species]Iterator
Returns the item located at the specified index.
Private checkRest ...items: (T | ConcatArray<T>)[]Returns the this object after copying a section of the array identified by start and end to the same array starting at position target
@@ -238,22 +238,22 @@ is treated as length+end.Optional end: numberIf not specified, length of the this object is used as its default value.
Returns an iterable of key, value pairs for every entry in the array
Determines whether all the members of an array satisfy the specified test.
Inherited from Array.every
Determines whether all the members of an array satisfy the specified test.
Changes all array elements from start to end index to a static value and returns the modified array
index to stop filling the array at. If end is negative, it is treated as length+end.
Returns the elements of an array that meet the condition specified in a callback function.
Inherited from Array.filter
Returns the elements of an array that meet the condition specified in a callback function.
Returns the value of the first element in the array where predicate is true, and undefined otherwise.
@@ -493,7 +493,7 @@ predicate. If it is not provided, undefined is used instead.Inherited from Array.find
Returns the index of the first element in the array where predicate is true, and -1 otherwise.
@@ -565,7 +565,7 @@ predicate. If it is not provided, undefined is used instead.Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.
@@ -593,7 +593,7 @@ specified depth.Calls a defined callback function on each element of an array. Then, flattens the result into a new array. @@ -643,7 +643,7 @@ thisArg is omitted, undefined is used as the this value.
Performs the specified action for each element in an array.
Determines whether an array includes a certain element, returning true or false as appropriate.
Returns the index of the first occurrence of a value in an array, or -1 if it is not present.
Adds all the elements of an array into a string, separated by the specified separator string.
Returns an iterable of keys in the array
Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.
Calls a defined callback function on each element of an array, and returns an array that contains the results.
Removes the last element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.
@@ -837,7 +837,7 @@ If the array is empty, undefined is returned and the array is not modified.Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Inherited from Array.reduce
Inherited from Array.reduce
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Inherited from Array.reduceRight
Inherited from Array.reduceRight
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Reverses the elements in an array in place. This method mutates the array and returns a reference to the same array.
@@ -1088,7 +1088,7 @@ This method mutates the array and returns a reference to the same array.Removes the first element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.
@@ -1100,7 +1100,7 @@ If the array is empty, undefined is returned and the array is not modified.Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. @@ -1126,7 +1126,7 @@ If end is undefined, then the slice extends to the end of the array.
Determines whether the specified callback function returns true for any element of an array.
Sorts an array in place. This method mutates the array and returns a reference to the same array.
@@ -1195,14 +1195,14 @@ value otherwise. If omitted, the elements are sorted in ascending, ASCII charactReturns a string representation of an array. The elements are converted to string using their toLocaleString methods.
Returns a string representation of an array.
Returns an iterable of values in the array
Static fromCreates an array from an array-like object.
Inherited from Array.from
Creates an array from an iterable object.
Inherited from Array.from
Creates an array from an iterable object.
Inherited from Array.from
Creates an array from an iterable object.
Static isStatic ofReturns a new array from a set of elements.
Constructs a new poolifier cluster worker.
Function processed by the worker when the pool's execution function is invoked.
Options for the worker.
Protected Optional Readonly aliveHandler id of the aliveInterval worker alive check.
Protected Readonly isWhether this is the main worker or not.
Protected lastTimestamp of the last task processed by this worker.
Protected mainReference to main worker.
Protected Readonly optsOptions for the worker.
The unique asyncId assigned to the resource.
Binds the given function to execute to this AsyncResource's scope.
The returned function will have an asyncResource property referencing
@@ -188,25 +188,25 @@ the AsyncResource to which the function is bound.
The function to bind to the current AsyncResource.
Protected checkCall all destroy hooks. This should only ever be called once. An error will
be thrown if it is called more than once. This must be manually called. If
@@ -215,14 +215,14 @@ never be called.
A reference to asyncResource.
Protected getReturns the main worker.
@@ -231,11 +231,11 @@ never be called.Protected handleHandles an error and convert it to a string so it can be sent back to the main worker.
@@ -251,11 +251,11 @@ never be called.Protected messageWorker message listener.
Message received.
Function processed by the worker when the pool's execution function is invoked.
Protected runRuns the given function synchronously.
Function that will be executed.
Input data for the given function.
Protected runRuns the given function asynchronously.
Function that will be executed.
Input data for the given function.
Call the provided function with the provided arguments in the execution context of the async resource. This will establish the context, trigger the AsyncHooks @@ -372,7 +372,7 @@ then restore the original execution context.
Protected sendSends a message to the main worker.
The response message.
The same triggerAsyncId that is passed to the AsyncResource constructor.
Static bindBinds the given function to the current execution context.
The returned function will have an asyncResource property referencing
@@ -430,7 +430,7 @@ the AsyncResource to which the function is bound.
Optional thisArg: ThisArgConstructs a new poolifier dynamic cluster pool.
Path to an implementation of a ClusterWorker file, which can be relative or absolute.
Options for this dynamic cluster pool.
Optional Readonly emitterEmitter on which events can be listened to.
Events that can currently be listened to:
Readonly filePath to the worker file.
Readonly maxMaximum number of workers that can be created by this pool.
Readonly numberNumber of workers that this pool should manage.
Readonly optsOptions for this fixed cluster pool.
Protected promiseThe execution response promise map.
key: The message id of each submitted task.Protected workerWorker choice strategy context referencing a worker choice algorithm implementation.
Default to a round robin algorithm.
Readonly workerPool worker nodes.
Protected fullPrivate numberPrivate numberProtected afterHook executed after the worker task execution. Can be overridden.
@@ -287,17 +287,17 @@ Can be overridden.The worker.
The received message.
Protected afterFunction 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 maxListeners or binding the main-worker<->worker connection if not bind by default.
Protected beforeHook executed before the worker task execution. Can be overridden.
@@ -331,25 +331,25 @@ Can be overridden.Protected chooseChooses a worker node for the next task.
The default uses a round robin algorithm to distribute the load.
[worker node key, worker node].
Protected createCreates a new worker and sets it up completely in the pool worker nodes.
@@ -358,33 +358,33 @@ Can be overridden.Protected createProtected destroyEnables/disables the worker tasks queue in this pool.
Whether to enable or disable the worker tasks queue.
Optional tasksQueueOptions: TasksQueueOptionsOptional tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
Executes the function specified in the worker constructor with the task data input parameter.
@@ -440,11 +440,11 @@ Can be overridden.Finds a free worker node key based on the number of tasks the worker has applied.
If a worker is found with 0 running tasks, it is detected as free and its worker node key is returned.
Protected internalProtected isProtected registerRegisters a listener callback on the given worker.
Protected sendSends a message to the given worker.
The worker which should receive the message.
The message.
Sets the worker tasks queue options in this pool.
The worker tasks queue options.
Sets the worker choice strategy in this pool.
The worker choice strategy.
Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsOptional workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
Sets the worker choice strategy options in this pool.
The worker choice strategy options.
Protected setupSetup hook to execute code before worker node are created in the abstract constructor. Can be overridden
@@ -605,11 +605,11 @@ Can be overriddenProtected workerThis function is the listener registered for each worker message.
@@ -629,11 +629,11 @@ Can be overriddenProtected sendSends a message to the given worker.
The worker which should receive the message.
The message.
Sets the worker tasks queue options in this pool.
The worker tasks queue options.
Sets the worker choice strategy in this pool.
The worker choice strategy.
Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsOptional workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
Sets the worker choice strategy options in this pool.
The worker choice strategy options.
Protected setupSetup hook to execute code before worker node are created in the abstract constructor. Can be overridden
@@ -605,11 +605,11 @@ Can be overriddenProtected workerThis function is the listener registered for each worker message.
@@ -629,11 +629,11 @@ Can be overriddenSets the worker choice strategy options in this pool.
The worker choice strategy options.
Protected setupSetup hook to execute code before worker node are created in the abstract constructor. Can be overridden
@@ -595,11 +595,11 @@ Can be overriddenProtected workerThis function is the listener registered for each worker message.
@@ -619,11 +619,11 @@ Can be overriddenProtected sendSends a message to the given worker.
The worker which should receive the message.
The message.
Sets the worker tasks queue options in this pool.
The worker tasks queue options.
Sets the worker choice strategy in this pool.
The worker choice strategy.
Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsOptional workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
Sets the worker choice strategy options in this pool.
The worker choice strategy options.
Protected setupSetup hook to execute code before worker node are created in the abstract constructor. Can be overridden
@@ -595,11 +595,11 @@ Can be overriddenProtected workerThis function is the listener registered for each worker message.
@@ -619,11 +619,11 @@ Can be overriddenThe worker tasks queue options.
The worker choice strategy.
Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsOptional workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
The worker choice strategy options.
Readonly typePool type.
If it is 'dynamic', it provides the max property.
Readonly workerPool worker nodes.
Readonly requiredRequired tasks usage statistics.
The worker choice strategy options.
Type of worker which manages this pool.