From cb4889b43e6935f6dd70d8011ba085c9ca7218ba Mon Sep 17 00:00:00 2001
From: "github-actions[bot]"
<41898282+github-actions[bot]@users.noreply.github.com>
Date: Mon, 4 Sep 2023 22:04:55 +0000
Subject: [PATCH] docs: generate documentation
---
docs/assets/main.js | 7 +-
docs/assets/navigation.js | 1 +
docs/assets/search.js | 2 +-
docs/assets/style.css | 10 +-
docs/classes/AbstractPool.html | 395 +++++++++---------
docs/classes/AbstractWorker.html | 280 ++++++-------
docs/classes/CircularArray.html | 281 +++++++------
docs/classes/ClusterWorker.html | 239 +++++------
docs/classes/Deque.html | 156 +++----
docs/classes/DynamicClusterPool.html | 286 ++++++-------
docs/classes/DynamicThreadPool.html | 289 ++++++-------
docs/classes/FixedClusterPool.html | 283 ++++++-------
docs/classes/FixedThreadPool.html | 286 ++++++-------
docs/classes/Node.html | 126 ++----
docs/classes/PoolEmitter.html | 186 ++++-----
docs/classes/ThreadWorker.html | 241 +++++------
docs/classes/WorkerChoiceStrategyContext.html | 162 +++----
docs/functions/availableParallelism.html | 112 ++---
docs/index.html | 118 ++----
docs/interfaces/ClusterPoolOptions.html | 140 +++----
...tLoopUtilizationMeasurementStatistics.html | 122 ++----
docs/interfaces/IPool.html | 168 +++-----
docs/interfaces/IWorker.html | 130 ++----
docs/interfaces/IWorkerChoiceStrategy.html | 136 +++---
docs/interfaces/IWorkerNode.html | 161 +++----
docs/interfaces/MeasurementOptions.html | 118 ++----
docs/interfaces/MeasurementStatistics.html | 128 ++----
.../MeasurementStatisticsRequirements.html | 122 ++----
docs/interfaces/MessageValue.html | 144 +++----
docs/interfaces/PoolInfo.html | 156 +++----
docs/interfaces/PoolOptions.html | 136 +++---
docs/interfaces/PromiseResponseWrapper.html | 124 ++----
docs/interfaces/StrategyData.html | 118 ++----
docs/interfaces/StrategyPolicy.html | 120 ++----
docs/interfaces/Task.html | 128 ++----
docs/interfaces/TaskError.html | 122 ++----
docs/interfaces/TaskPerformance.html | 124 ++----
docs/interfaces/TaskStatistics.html | 128 ++----
.../TaskStatisticsRequirements.html | 122 ++----
docs/interfaces/TasksQueueOptions.html | 122 ++----
docs/interfaces/ThreadPoolOptions.html | 138 +++---
.../WorkerChoiceStrategyOptions.html | 128 ++----
docs/interfaces/WorkerInfo.html | 126 ++----
docs/interfaces/WorkerOptions.html | 124 ++----
docs/interfaces/WorkerStatistics.html | 120 ++----
docs/interfaces/WorkerUsage.html | 124 ++----
docs/types/ErrorHandler.html | 110 ++---
docs/types/ExitHandler.html | 110 ++---
docs/types/KillBehavior.html | 110 ++---
docs/types/KillHandler.html | 110 ++---
docs/types/Measurement.html | 110 ++---
docs/types/MessageHandler.html | 110 ++---
docs/types/OnlineHandler.html | 110 ++---
docs/types/PoolEvent.html | 110 ++---
docs/types/PoolType.html | 110 ++---
docs/types/TaskAsyncFunction.html | 112 ++---
docs/types/TaskFunction.html | 110 ++---
docs/types/TaskFunctions.html | 110 ++---
docs/types/TaskSyncFunction.html | 112 ++---
docs/types/WorkerChoiceStrategy.html | 110 ++---
docs/types/WorkerNodeEventCallback.html | 113 ++---
docs/types/WorkerType.html | 110 ++---
docs/types/Writable.html | 110 ++---
docs/variables/KillBehaviors.html | 110 ++---
docs/variables/Measurements.html | 110 ++---
docs/variables/PoolEvents.html | 110 ++---
docs/variables/PoolTypes.html | 110 ++---
docs/variables/WorkerChoiceStrategies.html | 110 ++---
docs/variables/WorkerTypes.html | 110 ++---
69 files changed, 3554 insertions(+), 5972 deletions(-)
create mode 100644 docs/assets/navigation.js
diff --git a/docs/assets/main.js b/docs/assets/main.js
index 3cee05e61..01bcad55f 100644
--- a/docs/assets/main.js
+++ b/docs/assets/main.js
@@ -1,7 +1,8 @@
"use strict";
-"use strict";(()=>{var Se=Object.create;var re=Object.defineProperty;var we=Object.getOwnPropertyDescriptor;var Te=Object.getOwnPropertyNames;var ke=Object.getPrototypeOf,Qe=Object.prototype.hasOwnProperty;var Pe=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Ie=(t,e,r,n)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Te(e))!Qe.call(t,i)&&i!==r&&re(t,i,{get:()=>e[i],enumerable:!(n=we(e,i))||n.enumerable});return t};var Ce=(t,e,r)=>(r=t!=null?Se(ke(t)):{},Ie(e||!t||!t.__esModule?re(r,"default",{value:t,enumerable:!0}):r,t));var ae=Pe((se,oe)=>{(function(){var t=function(e){var r=new t.Builder;return r.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),r.searchPipeline.add(t.stemmer),e.call(r,r),r.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(r){e.console&&console.warn&&console.warn(r)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var r=Object.create(null),n=Object.keys(e),i=0;i Path to the worker file. Options for the pool. The worker. The added worker node key. https://nodejs.org/api/errors.html#class-error If the added worker node is not found.=e;r--){var n=this.uncheckedNodes[r],i=n.child.toString();i in this.minimizedNodes?n.parent.edges[n.char]=this.minimizedNodes[i]:(n.child._str=i,this.minimizedNodes[i]=n.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(r){var n=new t.QueryParser(e,r);n.parse()})},t.Index.prototype.query=function(e){for(var r=new t.Query(this.fields),n=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l
+
-
+ Index
Index
Constructors
-Properties
-Accessors
-Methods
-Constructors
constructor
+constructor
numberOfWorkers: number
filePath: string
opts: PoolOptions<Worker>
Returns AbstractPool<Worker, Data, Response>
Properties
Protected Readonly fileProtected Optional Readonly maxProtected Readonly number
@@ -241,7 +244,7 @@
Protected Readonly opts
@@ -254,7 +257,7 @@
Protected promisePrivate Readonly startPrivate startedPrivate Readonly starting
@@ -286,7 +289,7 @@
Protected worker
@@ -295,7 +298,7 @@
Readonly Internal workerAccessors
Returns boolean
Protected full
@@ -321,7 +324,7 @@
Returns boolean
info
@@ -333,7 +336,7 @@
Protected max
@@ -344,7 +347,7 @@
Returns number
Protected min
@@ -355,7 +358,7 @@
Returns number
Private ready
@@ -366,7 +369,7 @@
Returns boolean
Protected Abstract type
@@ -378,7 +381,7 @@
Returns "fixed" | "dynamic"
Private utilization
@@ -390,7 +393,7 @@
Protected Abstract worker
@@ -401,7 +404,7 @@
Returns "thread" | "cluster"
Methods
worker: Worker
Returns number
Throws
Protected after
@@ -439,15 +443,17 @@ Can be overridden.
The worker node key.
-The received message.
-Protected afterThe newly created worker node key.
-Protected beforeThe worker node key.
-The task to execute.
-Private buildPrivate checkPrivate checkPrivate checkProtected checkPrivate checkPrivate checkThe received message.
-https://nodejs.org/api/errors.html#class-error If the worker id is invalid.
Private checkPrivate checkPrivate checkPrivate checkPrivate checkPrivate chooseProtected createProtected createProtected Abstract createPrivate dequeueProtected Abstract destroyThe worker node key.
-Whether to enable or disable the worker node tasks queue.
-Optional tasksQueueOptions: TasksQueueOptionsThe worker node tasks queue options.
-Optional Private enqueueOptional data: DataThe optional task input data for the specified task function. This can only be structured-cloneable data.
-Optional Optional name: stringThe optional name of the task function to execute. If not specified, the default task function will be executed.
-Optional Optional transferList: 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.
-Optional Promise that will be fulfilled when the task is completed.
Private executeThe worker node key.
-The task to execute.
-Protected flushPrivate flushProtected getThe worker node key.
-The worker information.
Private getThe worker.
-The worker node key if found in the pool worker nodes, -1 otherwise.
Private getThe worker id.
-The worker node key if the worker id is found in the pool worker nodes, -1 otherwise.
Private handlePrivate handlePrivate hasThe worker node key.
-true if the worker node has back pressure, false otherwise.
Protected internalProtected Abstract isPrivate redistributeProtected Abstract registerThe worker node key.
-The message listener callback.
Private removeThe worker.
-Protected sendProtected Abstract sendThe worker node key.
-Private sendThe worker node key.
-Protected Abstract sendThe worker node key.
-The message.
-Optional transferList: TransferListItem[]The optional array of transferable objects.
-Optional The worker node tasks queue options.
-Private setThe worker choice strategy.
-Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
-Optional The worker choice strategy options.
-Protected setupPrivate shallPrivate shallPrivate shallThe worker node key.
-true if the worker node shall update its task function worker usage, false otherwise.
Private startPrivate taskPrivate tasksPrivate tasksPrivate updatePrivate updatePrivate updatePrivate updatePrivate updateProtected workerGenerated using TypeDoc
The type of async event.
-Whether this is the main worker or not.
-Reference to main worker.
-Task function(s) processed by the worker when the pool's execution function is invoked. The first function is the default function.
Options for the worker.
-Protected Abstract idProtected Readonly isProtected lastPrivate Readonly mainProtected optsProtected statisticsProtected taskThe name of the task function to add.
-The task function to add.
-Whether the task function was added or not.
https://nodejs.org/api/errors.html#class-typeerror If the fn parameter is not a function.
Optional name: stringOptional Optional name: stringThe function to bind to the current AsyncResource.
v14.8.0, v12.19.0
@@ -308,7 +316,7 @@ If a task function with the same name already exists, it is replaced.Private checkThe message to check.
-https://nodejs.org/api/errors.html#class-error If the message worker id is not set or does not match the worker id.
Private checkPrivate checkPrivate checkThe task function(s) parameter that should be checked.
-Private checkPrivate checkProtected gethttps://nodejs.org/api/errors.html#class-error If the main worker is not set.
Protected handleThe error raised by the worker.
-The error message.
Protected handleThe kill message.
-Protected Abstract handleThe ready message.
-The name of the task function to check.
-Whether the worker has a task function with the given name or not.
https://nodejs.org/api/errors.html#class-typeerror If the name parameter is not a string or an empty string.
Protected messageThe received message.
-The name of the task function to remove.
-Whether the task function existed and was removed or not.
https://nodejs.org/api/errors.html#class-error If the name parameter is the task function used as default task function.
Protected runThe task to execute.
-https://nodejs.org/api/errors.html#class-error If the task function is not found.
Protected runTask function that will be executed.
-Input data for the task function.
-The function to call in the execution context of this async resource.
Rest ...args: any[]Rest Rest ...args: any[]Optional thisArg: ThisThe receiver to be used for the function call.
-Optional Rest ...args: any[]Optional arguments to pass to the function.
-Rest v9.6.0
@@ -677,15 +699,17 @@ then restore the original execution context.Task function that will be executed.
-Input data for the task function.
-Protected sendProtected Abstract sendThe response message.
-The name of the task function to use as default task function.
-Whether the default task function was set or not.
https://nodejs.org/api/errors.html#class-error If the name parameter is a non-existing task function.
Private startPrivate stopStatic bindThe function to bind to the current execution context.
-Optional type: stringAn optional name to associate with the underlying AsyncResource.
Optional Optional thisArg: ThisArgOptional Optional thisArg: ThisArgv14.8.0, v12.19.0
@@ -819,15 +847,15 @@ then restore the original execution context.Generated using TypeDoc
Rest ...items: T[]Rest Rest ...items: T[]Static Readonly [species]Rest ...items: (T | ConcatArray<T>)[]Rest Rest ...items: (T | ConcatArray<T>)[]If target is negative, it is treated as length+target where length is the length of the array.
-If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
-Optional end: numberIf not specified, length of the this object is used as its default value.
-Optional Optional thisArg: any
An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
-Optional Inherited from Array.every
@@ -331,6 +337,7 @@ If thisArg is omitted, undefined is used as the this value. the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array. +Optional thisArg: any
An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
-Optional Inherited from Array.every
@@ -369,17 +377,20 @@ If thisArg is omitted, undefined is used as the this value.value to fill array section with
-Optional start: numberindex to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
-Optional Optional end: numberindex to stop filling the array at. If end is negative, it is treated as length+end.
-Optional Inherited from Array.fill
@@ -404,6 +415,7 @@ length+end.A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.
Optional thisArg: anyAn object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
-Optional Inherited from Array.filter
@@ -439,6 +452,7 @@ length+end.A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.
Optional thisArg: anyAn object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
-Optional Inherited from Array.filter
@@ -485,6 +500,7 @@ otherwise. order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. +Optional thisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
-Optional Inherited from Array.find
@@ -533,7 +550,7 @@ predicate. If it is not provided, undefined is used instead.Optional thisArg: anyOptional Optional thisArg: anyInherited from Array.find
Optional thisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
-Optional Inherited from Array.findIndex
@@ -603,7 +622,8 @@ specified depth.Optional depth: DThe maximum recursion depth
-Optional Inherited from Array.flat
@@ -633,6 +653,7 @@ This is identical to a map followed by flat with depth 1.A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array.
Optional thisArg: ThisAn object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.
-Optional Inherited from Array.flatMap
@@ -674,6 +696,7 @@ thisArg is omitted, undefined is used as the this value.A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional thisArg: anyAn object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
-Optional Inherited from Array.forEach
@@ -705,7 +729,7 @@ thisArg is omitted, undefined is used as the this value.The element to search for.
-Optional fromIndex: numberThe position in this array at which to begin searching for searchElement.
-Optional Inherited from Array.includes
@@ -742,11 +768,13 @@ thisArg is omitted, undefined is used as the this value.The value to locate in the array.
-Optional fromIndex: numberThe array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
-Optional Inherited from Array.indexOf
@@ -765,7 +793,8 @@ thisArg is omitted, undefined is used as the this value.Optional separator: stringA string used to separate one element of the array from the next in the resulting string. If omitted, the array elements are separated with a comma.
-Optional Inherited from Array.join
@@ -796,11 +825,13 @@ thisArg is omitted, undefined is used as the this value.The value to locate in the array.
-Optional fromIndex: numberThe array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.
-Optional Inherited from Array.lastIndexOf
@@ -825,6 +856,7 @@ thisArg is omitted, undefined is used as the this value.A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
Optional thisArg: anyAn object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
-Optional Inherited from Array.map
@@ -871,13 +904,13 @@ If the array is empty, undefined is returned and the array is not modified.Rest ...items: T[]Rest Rest ...items: T[]Overrides Array.push
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
-Inherited from Array.reduce
@@ -1000,6 +1036,7 @@ If the array is empty, undefined is returned and the array is not modified.A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
-Inherited from Array.reduceRight
@@ -1106,7 +1145,7 @@ If the array is empty, undefined is returned and the array is not modified.Optional start: numberThe beginning index of the specified portion of the array. If start is undefined, then the slice begins at index 0.
-Optional
+
+
Optional end: numberThe end index of the specified portion of the array. This is exclusive of the element at the index 'end'. If end is undefined, then the slice extends to the end of the array.
-Optional Inherited from Array.slice
@@ -1176,6 +1217,7 @@ If end is undefined, then the slice extends to the end of the array. the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value true, or until the end of the array. +Optional thisArg: anyAn object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
-Optional Inherited from Array.some
@@ -1219,7 +1262,8 @@ a negative value if the first argument is less than the second argument, zero if value otherwise. If omitted, the elements are sorted in ascending, ASCII character order.[11,2,22,1].sort((a, b) => a - b)
-Optional
+
+
Optional deleteCount: numberOptional Optional deleteCount: numberRest ...items: T[]Rest Rest ...items: T[]Overrides Array.splice
Rest ...items: T[]Rest Rest ...items: T[]Overrides Array.unshift
An array-like object to convert to an array.
-Inherited from Array.from
@@ -1351,11 +1396,13 @@ value otherwise. If omitted, the elements are sorted in ascending, ASCII charactAn array-like object to convert to an array.
-A mapping function to call on every element of the array.
Optional thisArg: anyValue of 'this' used to invoke the mapfn.
-Optional Inherited from Array.from
@@ -1393,7 +1441,8 @@ value otherwise. If omitted, the elements are sorted in ascending, ASCII charactAn iterable object to convert to an array.
-Inherited from Array.from
@@ -1416,11 +1465,13 @@ value otherwise. If omitted, the elements are sorted in ascending, ASCII charactAn iterable object to convert to an array.
-A mapping function to call on every element of the array.
Optional thisArg: anyValue of 'this' used to invoke the mapfn.
-Optional Inherited from Array.from
@@ -1475,7 +1527,8 @@ value otherwise. If omitted, the elements are sorted in ascending, ASCII charactRest ...items: T[]A set of elements to include in the new array object.
-Rest Inherited from Array.of
@@ -1485,15 +1538,15 @@ value otherwise. If omitted, the elements are sorted in ascending, ASCII charact +Generated using TypeDoc
Task function(s) processed by the worker when the pool's execution function is invoked.
Options for the worker.
-Overrides AbstractWorker.constructor
Inherited from AbstractWorker.activeInterval
Protected Readonly isInherited from AbstractWorker.isMain
Protected lastInherited from AbstractWorker.lastTaskTimestamp
Protected optsInherited from AbstractWorker.opts
Protected statisticsInherited from AbstractWorker.statistics
Protected taskInherited from AbstractWorker.taskFunctions
Overrides AbstractWorker.id
The name of the task function to add.
-The task function to add.
-Whether the task function was added or not.
Inherited from AbstractWorker.addTaskFunction
The function to bind to the current AsyncResource.
v14.8.0, v12.19.0
@@ -296,7 +301,7 @@ never be called.Inherited from AbstractWorker.getMainWorker
Protected handleThe error raised by the worker.
-The error message.
Inherited from AbstractWorker.handleError
Protected handleThe kill message.
-Inherited from AbstractWorker.handleKillMessage
Protected handleThe ready message.
-Overrides AbstractWorker.handleReadyMessage
The name of the task function to check.
-Whether the worker has a task function with the given name or not.
Inherited from AbstractWorker.hasTaskFunction
Inherited from AbstractWorker.listTaskFunctions
Protected messageThe received message.
-Inherited from AbstractWorker.messageListener
The name of the task function to remove.
-Whether the task function existed and was removed or not.
Inherited from AbstractWorker.removeTaskFunction
Protected runThe task to execute.
-https://nodejs.org/api/errors.html#class-error If the task function is not found.
Inherited from AbstractWorker.run
Protected runTask function that will be executed.
-Input data for the task function.
-Inherited from AbstractWorker.runAsync
The function to call in the execution context of this async resource.
Rest ...args: any[]Rest Rest ...args: any[]Optional thisArg: ThisThe receiver to be used for the function call.
-Optional Rest ...args: any[]Optional arguments to pass to the function.
-Rest v9.6.0
@@ -544,16 +561,18 @@ then restore the original execution context.Task function that will be executed.
-Input data for the task function.
-Inherited from AbstractWorker.runSync
Protected sendInherited from AbstractWorker.sendTaskFunctionsListToMainWorker
Protected sendThe response message.
-Overrides AbstractWorker.sendToMainWorker
The name of the task function to use as default task function.
-Whether the default task function was set or not.
Inherited from AbstractWorker.setDefaultTaskFunction
The function to bind to the current execution context.
-Optional type: stringAn optional name to associate with the underlying AsyncResource.
Optional Optional thisArg: ThisArgOptional Optional thisArg: ThisArgv14.8.0, v12.19.0
@@ -660,15 +683,15 @@ then restore the original execution context.Generated using TypeDoc
Private Optional headPrivate Optional tailhttps://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols
Private incrementData to append.
-The new size of the queue.
Data to prepend.
-The new size of the queue.
Generated using TypeDoc
Minimum number of workers which are always active.
-Maximum number of workers that can be created by this pool.
-Path to an implementation of a ClusterWorker file, which can be relative or absolute.
Options for this dynamic cluster pool.
-Overrides FixedClusterPool.constructor
Inherited from FixedClusterPool.emitter
Protected Readonly fileInherited from FixedClusterPool.filePath
Protected Readonly maxInherited from FixedClusterPool.max
Protected Readonly numberInherited from FixedClusterPool.numberOfWorkers
Protected Readonly optsInherited from FixedClusterPool.opts
Protected promiseInherited from FixedClusterPool.promiseResponseMap
Protected workerInherited from FixedClusterPool.workerChoiceStrategyContext
Readonly Internal workerInherited from FixedClusterPool.workerNodes
Overrides FixedClusterPool.busy
Protected fullInherited from FixedClusterPool.full
Inherited from FixedClusterPool.info
Protected maxInherited from FixedClusterPool.maxSize
Protected minInherited from FixedClusterPool.minSize
Private readyInherited from FixedClusterPool.ready
Protected typeOverrides FixedClusterPool.type
Private utilizationInherited from FixedClusterPool.utilization
Protected workerInherited from FixedClusterPool.worker
The worker node key.
-The received message.
-Inherited from FixedClusterPool.afterTaskExecutionHook
Protected afterThe newly created worker node key.
-Inherited from FixedClusterPool.afterWorkerNodeSetup
Protected beforeThe worker node key.
-The task to execute.
-Inherited from FixedClusterPool.beforeTaskExecutionHook
Protected checkInherited from FixedClusterPool.checkDynamicPoolSize
Protected createInherited from FixedClusterPool.createAndSetupDynamicWorkerNode
Protected createInherited from FixedClusterPool.createAndSetupWorkerNode
Protected createInherited from FixedClusterPool.createWorker
Inherited from FixedClusterPool.destroy
Protected destroyThe worker node key.
-Inherited from FixedClusterPool.destroyWorkerNode
Whether to enable or disable the worker node tasks queue.
-Optional tasksQueueOptions: TasksQueueOptionsThe worker node tasks queue options.
-Optional Inherited from FixedClusterPool.enableTasksQueue
Optional data: DataThe optional task input data for the specified task function. This can only be structured-cloneable data.
-Optional Optional name: stringThe optional name of the task function to execute. If not specified, the default task function will be executed.
-Optional Optional transferList: 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.
-Optional Promise that will be fulfilled when the task is completed.
Inherited from FixedClusterPool.execute
Protected flushInherited from FixedClusterPool.flushTasksQueue
Protected getThe worker node key.
-The worker information.
Inherited from FixedClusterPool.getWorkerInfo
The worker node key.
-true if the worker node has back pressure, false otherwise.
Inherited from FixedClusterPool.hasWorkerNodeBackPressure
Protected internalInherited from FixedClusterPool.internalBusy
Protected isInherited from FixedClusterPool.isMain
Inherited from FixedClusterPool.listTaskFunctions
Protected registerThe worker node key.
-The message listener callback.
Inherited from FixedClusterPool.registerWorkerMessageListener
Protected sendInherited from FixedClusterPool.sendKillMessageToWorker
Protected sendThe worker node key.
-Inherited from FixedClusterPool.sendStartupMessageToWorker
Protected sendThe worker node key.
-The message.
-Inherited from FixedClusterPool.sendToWorker
The worker node tasks queue options.
-Inherited from FixedClusterPool.setTasksQueueOptions
The worker choice strategy.
-Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
-Optional Inherited from FixedClusterPool.setWorkerChoiceStrategy
The worker choice strategy options.
-Inherited from FixedClusterPool.setWorkerChoiceStrategyOptions
Protected setupInherited from FixedClusterPool.setupHook
Protected workerInherited from FixedClusterPool.workerListener
Generated using TypeDoc
Minimum number of threads which are always active.
-Maximum number of threads that can be created by this pool.
-Path to an implementation of a ThreadWorker file, which can be relative or absolute.
Options for this dynamic thread pool.
-Overrides FixedThreadPool.constructor
Inherited from FixedThreadPool.emitter
Protected Readonly fileInherited from FixedThreadPool.filePath
Protected Readonly maxInherited from FixedThreadPool.max
Protected Readonly numberInherited from FixedThreadPool.numberOfWorkers
Protected Readonly optsInherited from FixedThreadPool.opts
Protected promiseInherited from FixedThreadPool.promiseResponseMap
Protected workerInherited from FixedThreadPool.workerChoiceStrategyContext
Readonly Internal workerInherited from FixedThreadPool.workerNodes
Overrides FixedThreadPool.busy
Protected fullInherited from FixedThreadPool.full
Inherited from FixedThreadPool.info
Protected maxInherited from FixedThreadPool.maxSize
Protected minInherited from FixedThreadPool.minSize
Private readyInherited from FixedThreadPool.ready
Protected typeOverrides FixedThreadPool.type
Private utilizationInherited from FixedThreadPool.utilization
Protected workerInherited from FixedThreadPool.worker
The worker node key.
-The received message.
-Inherited from FixedThreadPool.afterTaskExecutionHook
Protected afterThe newly created worker node key.
-Inherited from FixedThreadPool.afterWorkerNodeSetup
Protected beforeThe worker node key.
-The task to execute.
-Inherited from FixedThreadPool.beforeTaskExecutionHook
Protected checkInherited from FixedThreadPool.checkDynamicPoolSize
Protected createInherited from FixedThreadPool.createAndSetupDynamicWorkerNode
Protected createInherited from FixedThreadPool.createAndSetupWorkerNode
Protected createInherited from FixedThreadPool.createWorker
Inherited from FixedThreadPool.destroy
Protected destroyThe worker node key.
-Inherited from FixedThreadPool.destroyWorkerNode
Whether to enable or disable the worker node tasks queue.
-Optional tasksQueueOptions: TasksQueueOptionsThe worker node tasks queue options.
-Optional Inherited from FixedThreadPool.enableTasksQueue
Optional data: DataThe optional task input data for the specified task function. This can only be structured-cloneable data.
-Optional Optional name: stringThe optional name of the task function to execute. If not specified, the default task function will be executed.
-Optional Optional transferList: 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.
-Optional Promise that will be fulfilled when the task is completed.
Inherited from FixedThreadPool.execute
Protected flushInherited from FixedThreadPool.flushTasksQueue
Protected getThe worker node key.
-The worker information.
Inherited from FixedThreadPool.getWorkerInfo
The worker node key.
-true if the worker node has back pressure, false otherwise.
Inherited from FixedThreadPool.hasWorkerNodeBackPressure
Protected internalInherited from FixedThreadPool.internalBusy
Protected isInherited from FixedThreadPool.isMain
Inherited from FixedThreadPool.listTaskFunctions
Protected registerThe worker node key.
-The message listener callback.
Inherited from FixedThreadPool.registerWorkerMessageListener
Protected sendInherited from FixedThreadPool.sendKillMessageToWorker
Protected sendThe worker node key.
-Inherited from FixedThreadPool.sendStartupMessageToWorker
Protected sendThe worker node key.
-The message.
-Optional transferList: TransferListItem[]The optional array of transferable objects.
-Optional Inherited from FixedThreadPool.sendToWorker
The worker node tasks queue options.
-Inherited from FixedThreadPool.setTasksQueueOptions
The worker choice strategy.
-Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
-Optional Inherited from FixedThreadPool.setWorkerChoiceStrategy
The worker choice strategy options.
-Inherited from FixedThreadPool.setWorkerChoiceStrategyOptions
Protected setupInherited from FixedThreadPool.setupHook
Protected workerInherited from FixedThreadPool.workerListener
Generated using TypeDoc
Number of workers for this pool.
-Path to an implementation of a ClusterWorker file, which can be relative or absolute.
Options for this fixed cluster pool.
-Overrides AbstractPool.constructor
Inherited from AbstractPool.emitter
Protected Readonly fileInherited from AbstractPool.filePath
Protected Optional Readonly maxInherited from AbstractPool.max
Protected Readonly numberInherited from AbstractPool.numberOfWorkers
Protected Readonly optsInherited from AbstractPool.opts
Protected promiseInherited from AbstractPool.promiseResponseMap
Protected workerInherited from AbstractPool.workerChoiceStrategyContext
Readonly Internal workerInherited from AbstractPool.workerNodes
Overrides AbstractPool.busy
Protected fullInherited from AbstractPool.full
Inherited from AbstractPool.info
Protected maxInherited from AbstractPool.maxSize
Protected minInherited from AbstractPool.minSize
Private readyInherited from AbstractPool.ready
Protected typeOverrides AbstractPool.type
Private utilizationInherited from AbstractPool.utilization
Protected workerOverrides AbstractPool.worker
The worker node key.
-The received message.
-Inherited from AbstractPool.afterTaskExecutionHook
Protected afterThe newly created worker node key.
-Inherited from AbstractPool.afterWorkerNodeSetup
Protected beforeThe worker node key.
-The task to execute.
-Inherited from AbstractPool.beforeTaskExecutionHook
Protected checkInherited from AbstractPool.checkDynamicPoolSize
Protected createInherited from AbstractPool.createAndSetupDynamicWorkerNode
Protected createInherited from AbstractPool.createAndSetupWorkerNode
Protected createOverrides AbstractPool.createWorker
Inherited from AbstractPool.destroy
Protected destroyThe worker node key.
-Overrides AbstractPool.destroyWorkerNode
Whether to enable or disable the worker node tasks queue.
-Optional tasksQueueOptions: TasksQueueOptionsThe worker node tasks queue options.
-Optional Inherited from AbstractPool.enableTasksQueue
Optional data: DataThe optional task input data for the specified task function. This can only be structured-cloneable data.
-Optional Optional name: stringThe optional name of the task function to execute. If not specified, the default task function will be executed.
-Optional Optional transferList: 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.
-Optional Promise that will be fulfilled when the task is completed.
Inherited from AbstractPool.execute
Protected flushInherited from AbstractPool.flushTasksQueue
Protected getThe worker node key.
-The worker information.
Inherited from AbstractPool.getWorkerInfo
The worker node key.
-true if the worker node has back pressure, false otherwise.
Inherited from AbstractPool.hasWorkerNodeBackPressure
Protected internalInherited from AbstractPool.internalBusy
Protected isOverrides AbstractPool.isMain
Inherited from AbstractPool.listTaskFunctions
Protected registerThe worker node key.
-The message listener callback.
Overrides AbstractPool.registerWorkerMessageListener
Protected sendInherited from AbstractPool.sendKillMessageToWorker
Protected sendThe worker node key.
-Overrides AbstractPool.sendStartupMessageToWorker
Protected sendThe worker node key.
-The message.
-Overrides AbstractPool.sendToWorker
The worker node tasks queue options.
-Inherited from AbstractPool.setTasksQueueOptions
The worker choice strategy.
-Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
-Optional Inherited from AbstractPool.setWorkerChoiceStrategy
The worker choice strategy options.
-Inherited from AbstractPool.setWorkerChoiceStrategyOptions
Protected setupOverrides AbstractPool.setupHook
Protected workerInherited from AbstractPool.workerListener
Generated using TypeDoc
Number of threads for this pool.
-Path to an implementation of a ThreadWorker file, which can be relative or absolute.
Options for this fixed thread pool.
-Overrides AbstractPool.constructor
Inherited from AbstractPool.emitter
Protected Readonly fileInherited from AbstractPool.filePath
Protected Optional Readonly maxInherited from AbstractPool.max
Protected Readonly numberInherited from AbstractPool.numberOfWorkers
Protected Readonly optsInherited from AbstractPool.opts
Protected promiseInherited from AbstractPool.promiseResponseMap
Protected workerInherited from AbstractPool.workerChoiceStrategyContext
Readonly Internal workerInherited from AbstractPool.workerNodes
Overrides AbstractPool.busy
Protected fullInherited from AbstractPool.full
Inherited from AbstractPool.info
Protected maxInherited from AbstractPool.maxSize
Protected minInherited from AbstractPool.minSize
Private readyInherited from AbstractPool.ready
Protected typeOverrides AbstractPool.type
Private utilizationInherited from AbstractPool.utilization
Protected workerOverrides AbstractPool.worker
The worker node key.
-The received message.
-Inherited from AbstractPool.afterTaskExecutionHook
Protected afterThe newly created worker node key.
-Inherited from AbstractPool.afterWorkerNodeSetup
Protected beforeThe worker node key.
-The task to execute.
-Inherited from AbstractPool.beforeTaskExecutionHook
Protected checkInherited from AbstractPool.checkDynamicPoolSize
Protected createInherited from AbstractPool.createAndSetupDynamicWorkerNode
Protected createInherited from AbstractPool.createAndSetupWorkerNode
Protected createOverrides AbstractPool.createWorker
Inherited from AbstractPool.destroy
Protected destroyThe worker node key.
-Overrides AbstractPool.destroyWorkerNode
Whether to enable or disable the worker node tasks queue.
-Optional tasksQueueOptions: TasksQueueOptionsThe worker node tasks queue options.
-Optional Inherited from AbstractPool.enableTasksQueue
Optional data: DataThe optional task input data for the specified task function. This can only be structured-cloneable data.
-Optional Optional name: stringThe optional name of the task function to execute. If not specified, the default task function will be executed.
-Optional Optional transferList: 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.
-Optional Promise that will be fulfilled when the task is completed.
Inherited from AbstractPool.execute
Protected flushInherited from AbstractPool.flushTasksQueue
Protected getThe worker node key.
-The worker information.
Inherited from AbstractPool.getWorkerInfo
The worker node key.
-true if the worker node has back pressure, false otherwise.
Inherited from AbstractPool.hasWorkerNodeBackPressure
Protected internalInherited from AbstractPool.internalBusy
Protected isOverrides AbstractPool.isMain
Inherited from AbstractPool.listTaskFunctions
Protected registerThe worker node key.
-The message listener callback.
Overrides AbstractPool.registerWorkerMessageListener
Protected sendInherited from AbstractPool.sendKillMessageToWorker
Protected sendThe worker node key.
-Overrides AbstractPool.sendStartupMessageToWorker
Protected sendThe worker node key.
-The message.
-Optional transferList: TransferListItem[]The optional array of transferable objects.
-Optional Overrides AbstractPool.sendToWorker
The worker node tasks queue options.
-Inherited from AbstractPool.setTasksQueueOptions
The worker choice strategy.
-Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
-Optional Inherited from AbstractPool.setWorkerChoiceStrategy
The worker choice strategy options.
-Inherited from AbstractPool.setWorkerChoiceStrategyOptions
Protected setupInherited from AbstractPool.setupHook
Protected workerInherited from AbstractPool.workerListener
Generated using TypeDoc
Optional nextOptional prevGenerated using TypeDoc
Optional options: EventEmitterOptionsOptional Optional options: EventEmitterOptionsInherited from EventEmitter.constructor
'error' listener is installed.
Rest ...args: any[]Rest Rest ...args: any[]Rest ...args: any[]Rest Rest ...args: any[]v0.1.26
@@ -260,11 +260,13 @@ in the list of the listeners of the event.The name of the event being listened for
-Optional listener: FunctionThe event handler function
-Optional v3.2.0
@@ -316,7 +318,7 @@ in the list of the listeners of the event.Rest ...args: any[]Rest Rest ...args: any[]The name of the event.
-The callback function
Rest ...args: any[]Rest Rest ...args: any[]The name of the event.
-The callback function
Rest ...args: any[]Rest Rest ...args: any[]The name of the event.
-The callback function
Rest ...args: any[]Rest Rest ...args: any[]The name of the event.
-The callback function
Rest ...args: any[]Rest Rest ...args: any[]Optional event: string | symbolOptional Optional event: string | symbolv0.1.26
@@ -587,7 +597,7 @@ recently added instance. In the example theonce('ping')lis
Rest ...args: any[]Rest Rest ...args: any[]Static listenerStatic listenerThe event name
-v0.9.12
@@ -768,9 +780,10 @@ composed of the emitted event arguments.The name of the event being listened for
-Optional options: StaticEventEmitterOptionsOptional Optional options: StaticEventEmitterOptionsthat iterates eventName events emitted by the emitter
Optional options: StaticEventEmitterOptionsOptional Optional options: StaticEventEmitterOptionsv11.13.0, v10.16.0
@@ -827,7 +840,7 @@ special handling:Optional options: StaticEventEmitterOptionsOptional Optional options: StaticEventEmitterOptionsInherited from EventEmitter.once
Optional n: numberA non-negative number. The maximum number of listeners per EventTarget event.
Optional Rest ...eventTargets: (EventEmitter | _DOMEventTarget)[]Rest Rest ...eventTargets: (EventEmitter | _DOMEventTarget)[]v15.4.0
@@ -860,15 +874,15 @@ special handling:Generated using TypeDoc
Task function(s) processed by the worker when the pool's execution function is invoked.
Options for the worker.
-Overrides AbstractWorker.constructor
Inherited from AbstractWorker.activeInterval
Protected Readonly isInherited from AbstractWorker.isMain
Protected lastInherited from AbstractWorker.lastTaskTimestamp
Protected optsInherited from AbstractWorker.opts
Private portProtected statisticsInherited from AbstractWorker.statistics
Protected taskInherited from AbstractWorker.taskFunctions
Overrides AbstractWorker.id
The name of the task function to add.
-The task function to add.
-Whether the task function was added or not.
Inherited from AbstractWorker.addTaskFunction
The function to bind to the current AsyncResource.
v14.8.0, v12.19.0
@@ -305,7 +310,7 @@ never be called.Inherited from AbstractWorker.getMainWorker
Protected handleThe error raised by the worker.
-The error message.
Overrides AbstractWorker.handleError
Protected handleThe kill message.
-Overrides AbstractWorker.handleKillMessage
Protected handleThe ready message.
-Overrides AbstractWorker.handleReadyMessage
The name of the task function to check.
-Whether the worker has a task function with the given name or not.
Inherited from AbstractWorker.hasTaskFunction
Inherited from AbstractWorker.listTaskFunctions
Protected messageThe received message.
-Inherited from AbstractWorker.messageListener
The name of the task function to remove.
-Whether the task function existed and was removed or not.
Inherited from AbstractWorker.removeTaskFunction
Protected runThe task to execute.
-https://nodejs.org/api/errors.html#class-error If the task function is not found.
Inherited from AbstractWorker.run
Protected runTask function that will be executed.
-Input data for the task function.
-Inherited from AbstractWorker.runAsync
The function to call in the execution context of this async resource.
Rest ...args: any[]Rest Rest ...args: any[]Optional thisArg: ThisThe receiver to be used for the function call.
-Optional Rest ...args: any[]Optional arguments to pass to the function.
-Rest v9.6.0
@@ -553,16 +570,18 @@ then restore the original execution context.Task function that will be executed.
-Input data for the task function.
-Inherited from AbstractWorker.runSync
Protected sendInherited from AbstractWorker.sendTaskFunctionsListToMainWorker
Protected sendThe response message.
-Overrides AbstractWorker.sendToMainWorker
The name of the task function to use as default task function.
-Whether the default task function was set or not.
Inherited from AbstractWorker.setDefaultTaskFunction
The function to bind to the current execution context.
-Optional type: stringAn optional name to associate with the underlying AsyncResource.
Optional Optional thisArg: ThisArgOptional Optional thisArg: ThisArgv14.8.0, v12.19.0
@@ -669,15 +692,15 @@ then restore the original execution context.Generated using TypeDoc
The pool instance.
-The worker choice strategy.
-The worker choice strategy options.
-Private retriesPrivate Readonly workerPrivate workerhttps://nodejs.org/api/errors.html#class-error If after configured retries the worker node key is null or undefined .
The worker node key.
-true if the removal is successful, false otherwise.
The worker choice strategy options.
-The worker choice strategy to set.
-Generated using TypeDoc
Returns safe host OS optimized estimate of the default amount of parallelism a pool should use. Always returns a value greater than zero.
@@ -26,89 +26,47 @@ Always returns a value greater than zero.Generated using TypeDoc
Generated using TypeDoc
Optional enableOptional enablePool events emission.
Inherited from PoolOptions.enableEvents
Optional enableInherited from PoolOptions.enableTasksQueue
Optional envhttps://nodejs.org/api/cluster.html#cluster_cluster_fork_env
Optional errorInherited from PoolOptions.errorHandler
Optional exitInherited from PoolOptions.exitHandler
Optional messageInherited from PoolOptions.messageHandler
Optional onlineInherited from PoolOptions.onlineHandler
Optional restartInherited from PoolOptions.restartWorkerOnError
Optional settingshttps://nodejs.org/api/cluster.html#cluster_cluster_settings
Optional tasksInherited from PoolOptions.tasksQueueOptions
Optional workerInherited from PoolOptions.workerChoiceStrategy
Optional workerInherited from PoolOptions.workerChoiceStrategyOptions
Generated using TypeDoc
Readonly activeReadonly activeReadonly idleOptional utilizationGenerated using TypeDoc
Readonly destroyReadonly destroyOptional Readonly emitterReadonly enableWhether to enable or disable the worker node tasks queue.
-Optional tasksQueueOptions: TasksQueueOptionsThe worker node tasks queue options.
-Optional Readonly executeOptional data: DataThe optional task input data for the specified task function. This can only be structured-cloneable data.
-Optional Optional name: stringThe optional name of the task function to execute. If not specified, the default task function will be executed.
-Optional Optional transferList: 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.
-Optional Promise that will be fulfilled when the task is completed.
Readonly hasThe worker node key.
-true if the worker node has back pressure, false otherwise.
Readonly infoReadonly listReadonly setThe worker node tasks queue options.
-Readonly setThe worker choice strategy.
-Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
-Optional Readonly setThe worker choice strategy options.
-Readonly Internal workerGenerated using TypeDoc
Optional Readonly idOptional Readonly idWorker id.
Readonly onThe event handler.
Readonly onceThe 'exit' event.
The exit handler.
-Optional Readonly threadGenerated using TypeDoc
Readonly chooseReadonly chooseundefined is returned.
Readonly removeundefined is returned.
The worker node key.
-true if the worker node key is removed, false otherwise.
Readonly resetundefined is returned.
Readonly setundefined is returned.
The worker choice strategy options.
-Readonly strategyundefined is returned.
Readonly taskundefined is returned.
Readonly updateundefined is returned.
Generated using TypeDoc
Readonly clearReadonly clearReadonly closeReadonly dequeueReadonly enqueueThe task to queue.
-The tasks queue size.
Readonly getThe task function name.
-The task function worker usage statistics if the task function worker usage statistics are initialized, undefined otherwise.
Readonly hasReadonly infoOptional Readonly messageOptional onOptional onReadonly popReadonly resetOptional strategyReadonly tasksReadonly unshiftThe task to prepend.
-The tasks queue size.
Readonly usageReadonly workerGenerated using TypeDoc
Generated using TypeDoc
Optional aggregateOptional aggregateMeasurement aggregate.
Optional averageReadonly historyOptional maximumOptional medianOptional minimumGenerated using TypeDoc
Requires measurement aggregate.
Generated using TypeDoc
Optional Readonly checkOptional Readonly checkWhether the worker starts or stops its activity check.
Optional Readonly dataOptional Readonly killOptional Readonly nameOptional Readonly portOptional Readonly readyOptional Readonly statisticsOptional Readonly taskOptional Readonly taskOptional Readonly taskOptional Readonly taskOptional Readonly timestampOptional Readonly transferInherited from Task.transferList
Readonly workerGenerated using TypeDoc
Optional Readonly backOptional Readonly backReadonly busyReadonly executedReadonly executingReadonly failedReadonly idleOptional Readonly maxReadonly maxReadonly minOptional Readonly queuedReadonly readyOptional Readonly runReadonly minimum: numberOptional Readonly stolenReadonly strategyReadonly typeOptional Readonly utilizationReadonly versionOptional Readonly waitReadonly minimum: numberReadonly workerReadonly workerGenerated using TypeDoc
Optional enableOptional enablePool events emission.
Optional enableOptional errorOptional exitOptional messageOptional onlineOptional restartOptional tasksOptional workerOptional workerGenerated using TypeDoc
Readonly resolveReadonly workerGenerated using TypeDoc
Optional virtualOptional virtualGenerated using TypeDoc
Readonly dynamicReadonly dynamicExpects the newly created dynamic worker to be flagged as ready.
Readonly dynamicGenerated using TypeDoc
Optional Readonly dataOptional Readonly dataTask input data that will be passed to the worker.
Optional Readonly nameOptional Readonly taskOptional Readonly timestampOptional Readonly transferReadonly workerGenerated using TypeDoc
Optional Readonly dataOptional Readonly dataData triggering the error.
Readonly messageReadonly nameGenerated using TypeDoc
Optional Readonly eluOptional Readonly eluTask event loop utilization.
Readonly nameOptional Readonly runReadonly timestampGenerated using TypeDoc
Number of executed tasks.
Optional Readonly maxReadonly queuedGenerated using TypeDoc
Readonly eluReadonly eluTasks event loop utilization requirements.
Readonly runReadonly waitGenerated using TypeDoc
Optional Readonly concurrencyOptional Readonly concurrencyMaximum number of tasks that can be executed concurrently on a worker node.
Optional Readonly queueUse size instead.
Optional Readonly sizeGenerated using TypeDoc
Optional enableOptional enablePool events emission.
Inherited from PoolOptions.enableEvents
Optional enableInherited from PoolOptions.enableTasksQueue
Optional errorInherited from PoolOptions.errorHandler
Optional exitInherited from PoolOptions.exitHandler
Optional messageInherited from PoolOptions.messageHandler
Optional onlineInherited from PoolOptions.onlineHandler
Optional restartInherited from PoolOptions.restartWorkerOnError
Optional tasksInherited from PoolOptions.tasksQueueOptions
Optional workerInherited from PoolOptions.workerChoiceStrategy
Optional workerInherited from PoolOptions.workerChoiceStrategyOptions
Optional workerhttps://nodejs.org/api/worker_threads.html#new-workerfilename-options
Generated using TypeDoc
Optional Readonly eluOptional Readonly eluEvent loop utilization options.
Optional Readonly measurementOptional Readonly retriesOptional Readonly runOptional Readonly waitOptional Readonly weightsGenerated using TypeDoc
Dynamic flag.
Readonly idOptional taskReadonly typeGenerated using TypeDoc
Optional asyncOptional asyncWhether your worker will perform asynchronous or not.
This option will be removed in the next major version.
Optional killOptional killOptional maxGenerated using TypeDoc
Readonly eluReadonly eluWhether the worker computes the task event loop utilization (ELU) or not.
Readonly runGenerated using TypeDoc
Readonly eluReadonly eluTasks event loop utilization statistics.
Readonly runReadonly tasksReadonly waitGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Optional data: DataOptional Optional data: DataGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Optional data: DataOptional Optional data: DataGenerated using TypeDoc
Generated using TypeDoc
The worker id.
-Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Readonly waitGenerated using TypeDoc
Readonly taskGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Readonly thread: "thread"Generated using TypeDoc
Number of workers that this pool should manage.
-