From 323daa7f98fd16385379e4b6e8def0a9a3f140c8 Mon Sep 17 00:00:00 2001
From: "github-actions[bot]"
<41898282+github-actions[bot]@users.noreply.github.com>
Date: Sat, 26 Aug 2023 22:48:10 +0000
Subject: [PATCH] chore: generate documentation
---
docs/assets/highlight.css | 7 +
docs/assets/main.js | 2 +-
docs/assets/search.js | 2 +-
docs/assets/style.css | 26 +-
docs/classes/AbstractPool.html | 311 ++++++++----------
docs/classes/AbstractWorker.html | 224 +++++--------
docs/classes/CircularArray.html | 299 +++++++----------
docs/classes/ClusterWorker.html | 159 ++++-----
docs/classes/Deque.html | 78 +++--
docs/classes/DynamicClusterPool.html | 206 +++++-------
docs/classes/DynamicThreadPool.html | 209 +++++-------
docs/classes/FixedClusterPool.html | 203 +++++-------
docs/classes/FixedThreadPool.html | 206 +++++-------
docs/classes/Node.html | 50 +--
docs/classes/PoolEmitter.html | 104 +++---
docs/classes/ThreadWorker.html | 161 ++++-----
docs/classes/WorkerChoiceStrategyContext.html | 84 +++--
docs/functions/availableParallelism.html | 42 +--
docs/index.html | 74 ++---
docs/interfaces/ClusterPoolOptions.html | 75 +++--
...tLoopUtilizationMeasurementStatistics.html | 48 +--
docs/interfaces/IPool.html | 94 +++---
docs/interfaces/IWorker.html | 56 ++--
docs/interfaces/IWorkerChoiceStrategy.html | 62 ++--
docs/interfaces/IWorkerNode.html | 91 +++--
docs/interfaces/MeasurementOptions.html | 44 +--
docs/interfaces/MeasurementStatistics.html | 54 +--
.../MeasurementStatisticsRequirements.html | 48 +--
docs/interfaces/MessageValue.html | 70 ++--
docs/interfaces/PoolInfo.html | 82 ++---
docs/interfaces/PoolOptions.html | 71 ++--
docs/interfaces/PromiseResponseWrapper.html | 50 +--
docs/interfaces/StrategyPolicy.html | 46 +--
docs/interfaces/Task.html | 54 +--
docs/interfaces/TaskError.html | 48 +--
docs/interfaces/TaskPerformance.html | 50 +--
docs/interfaces/TaskStatistics.html | 54 +--
.../TaskStatisticsRequirements.html | 48 +--
docs/interfaces/TasksQueueOptions.html | 54 +--
docs/interfaces/ThreadPoolOptions.html | 73 ++--
.../WorkerChoiceStrategyOptions.html | 69 ++--
docs/interfaces/WorkerInfo.html | 52 +--
docs/interfaces/WorkerOptions.html | 59 ++--
docs/interfaces/WorkerStatistics.html | 46 +--
docs/interfaces/WorkerUsage.html | 50 +--
docs/types/ErrorHandler.html | 42 +--
docs/types/ExitHandler.html | 42 +--
docs/types/KillBehavior.html | 42 +--
docs/types/KillHandler.html | 42 +--
docs/types/Measurement.html | 42 +--
docs/types/MessageHandler.html | 42 +--
docs/types/OnlineHandler.html | 42 +--
docs/types/PoolEvent.html | 42 +--
docs/types/PoolType.html | 42 +--
docs/types/TaskAsyncFunction.html | 44 +--
docs/types/TaskFunction.html | 42 +--
docs/types/TaskFunctions.html | 42 +--
docs/types/TaskSyncFunction.html | 44 +--
docs/types/WorkerChoiceStrategy.html | 42 +--
docs/types/WorkerType.html | 42 +--
docs/types/Writable.html | 42 +--
docs/variables/KillBehaviors.html | 42 +--
docs/variables/Measurements.html | 42 +--
docs/variables/PoolEvents.html | 42 +--
docs/variables/PoolTypes.html | 42 +--
docs/variables/WorkerChoiceStrategies.html | 42 +--
docs/variables/WorkerTypes.html | 42 +--
67 files changed, 2315 insertions(+), 2608 deletions(-)
diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css
index e1c34dacf..df206d0c4 100644
--- a/docs/assets/highlight.css
+++ b/docs/assets/highlight.css
@@ -19,6 +19,8 @@
--dark-hl-8: #6A9955;
--light-hl-9: #267F99;
--dark-hl-9: #4EC9B0;
+ --light-hl-10: #000000;
+ --dark-hl-10: #C8C8C8;
--light-code-background: #FFFFFF;
--dark-code-background: #1E1E1E;
}
@@ -34,6 +36,7 @@
--hl-7: var(--light-hl-7);
--hl-8: var(--light-hl-8);
--hl-9: var(--light-hl-9);
+ --hl-10: var(--light-hl-10);
--code-background: var(--light-code-background);
} }
@@ -48,6 +51,7 @@
--hl-7: var(--dark-hl-7);
--hl-8: var(--dark-hl-8);
--hl-9: var(--dark-hl-9);
+ --hl-10: var(--dark-hl-10);
--code-background: var(--dark-code-background);
} }
@@ -62,6 +66,7 @@
--hl-7: var(--light-hl-7);
--hl-8: var(--light-hl-8);
--hl-9: var(--light-hl-9);
+ --hl-10: var(--light-hl-10);
--code-background: var(--light-code-background);
}
@@ -76,6 +81,7 @@
--hl-7: var(--dark-hl-7);
--hl-8: var(--dark-hl-8);
--hl-9: var(--dark-hl-9);
+ --hl-10: var(--dark-hl-10);
--code-background: var(--dark-code-background);
}
@@ -89,4 +95,5 @@
.hl-7 { color: var(--hl-7); }
.hl-8 { color: var(--hl-8); }
.hl-9 { color: var(--hl-9); }
+.hl-10 { color: var(--hl-10); }
pre, code { background: var(--code-background); }
diff --git a/docs/assets/main.js b/docs/assets/main.js
index 4c8fa615a..3cee05e61 100644
--- a/docs/assets/main.js
+++ b/docs/assets/main.js
@@ -1,6 +1,6 @@
"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;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
+
@@ -174,22 +174,19 @@
numberOfWorkers: number
filePath: string
opts: PoolOptions<Worker>
Returns AbstractPool<Worker, Data, Response>
+Properties
Protected Readonly fileProtected Optional Readonly maxProtected Readonly number
@@ -242,7 +239,7 @@
Protected Readonly opts
@@ -255,7 +252,7 @@
Protected promisePrivate Readonly startPrivate startedPrivate Readonly starting
@@ -287,7 +284,7 @@
Protected worker
@@ -296,7 +293,7 @@
Readonly Internal workerAccessors
Returns boolean
Protected full
@@ -322,7 +319,7 @@
Returns boolean
info
@@ -334,7 +331,7 @@
Protected max
@@ -345,7 +342,7 @@
Returns number
Protected min
@@ -356,7 +353,7 @@
Returns number
Private ready
@@ -367,7 +364,7 @@
Returns boolean
Protected Abstract type
@@ -379,7 +376,7 @@
Returns "fixed" | "dynamic"
Private utilization
@@ -391,7 +388,7 @@
Protected Abstract worker
@@ -402,7 +399,7 @@
Returns "thread" | "cluster"
Methods
worker: Worker
Returns number
Throws
Protected after
@@ -441,17 +437,15 @@ 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
Private setThe worker node tasks queue options.
-The worker choice strategy.
-Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
-Optional
The worker choice strategy options.
-Protected setupPrivate 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 updateProtected workerGenerated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index a736170ba..f36ce8440 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -1,4 +1,4 @@ -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 name: stringOptional The function to bind to the current AsyncResource.
v14.8.0, v12.19.0
@@ -316,7 +307,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 checkProtected getPrivate getGets the task function with the given name.
-Optional name: stringName of the task function that will be returned.
-The task function.
- -https://nodejs.org/api/errors.html#class-error If the task function is not found.
-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 ...args: any[]Rest 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
@@ -704,17 +659,15 @@ 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 thisArg: ThisArgOptional
v14.8.0, v12.19.0
@@ -889,7 +838,6 @@ then restore the original execution context.Generated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/classes/CircularArray.html b/docs/classes/CircularArray.html index 7d1d70929..c0cdc3283 100644 --- a/docs/classes/CircularArray.html +++ b/docs/classes/CircularArray.html @@ -1,4 +1,4 @@ -Rest ...items: T[]Rest ...items: T[]Rest Static Readonly [species]The zero-based index of the desired code unit. A negative index will count back from the last item.
-Private checkRest ...items: (T | ConcatArray<T>)[]Rest ...items: (T | ConcatArray<T>)[]Rest 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,24 +237,21 @@ to the same array starting at position targetIf target is negative, it is treated as length+target where length is the length of the array.
-Optional start: numberIf start is negative, it is treated as length+start. If end is negative, it
-is treated as length+end. If start is omitted, 0 is used.
Optional end: numberIf not specified, length of the this object is used as its default value.
-Optional
0 is used.
0 is used.
0 is used.
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 Determines whether all the members of an array satisfy the specified test.
@@ -337,7 +331,6 @@ 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 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
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 Returns the elements of an array that meet the condition specified in a callback function.
@@ -452,7 +439,6 @@ 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 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 Optional thisArg: anyOptional thisArg: anyOptional
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 Optional depth: DThe maximum recursion depth
-Optional
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 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 The element to search for.
-Optional fromIndex: numberThe position in this array at which to begin searching for searchElement.
-Optional
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
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
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
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 Rest ...items: T[]Rest ...items: T[]Rest A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
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.
@@ -994,7 +960,6 @@ If the array is empty, undefined is returned and the array is not modified.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.
-A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
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.
@@ -1105,7 +1068,6 @@ 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.
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.
-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
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 [11,2,22,1].sort((a, b) => a - b)
-
-
+Optional
Optional deleteCount: numberOptional deleteCount: numberOptional
Rest ...items: T[]Rest ...items: T[]Rest
Rest ...items: T[]Rest ...items: T[]Rest Static fromAn array-like object to convert to an array.
-Creates an array from an iterable object.
@@ -1396,13 +1351,11 @@ 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 Creates an array from an iterable object.
@@ -1441,13 +1393,12 @@ value otherwise. If omitted, the elements are sorted in ascending, ASCII charactAn iterable object to convert to an array.
-Creates an array from an iterable object.
@@ -1465,13 +1416,11 @@ 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 Static isStatic ofRest ...items: T[]A set of elements to include in the new array object.
-Rest
Generated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/classes/ClusterWorker.html b/docs/classes/ClusterWorker.html index cddb4f8ce..1d5f2f8b3 100644 --- a/docs/classes/ClusterWorker.html +++ b/docs/classes/ClusterWorker.html @@ -1,4 +1,4 @@ -Task function(s) processed by the worker when the pool's execution function is invoked.
Options for the worker.
-Protected Readonly isProtected lastProtected optsProtected statisticsProtected taskThe name of the task function to add.
-The task function to add.
-Whether the task function was added or not.
The function to bind to the current AsyncResource.
v14.8.0, v12.19.0
@@ -299,7 +294,7 @@ never be called. +Protected handleThe error raised by the worker.
-The error message.
Protected handleThe kill message.
-Protected handleThe ready message.
-The name of the task function to check.
-Whether the worker has a task function with the given name or not.
Protected messageThe received message.
-The name of the task function to remove.
-Whether the task function existed and was removed or not.
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 ...args: any[]Rest 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
@@ -559,18 +542,16 @@ then restore the original execution context.Task function that will be executed.
-Input data for the task function.
-Protected sendProtected sendThe response message.
-The name of the task function to use as default task function.
-Whether the default task function was set or not.
The function to bind to the current execution context.
-Optional type: stringAn optional name to associate with the underlying AsyncResource.
Optional
Optional thisArg: ThisArgOptional thisArg: ThisArgOptional
v14.8.0, v12.19.0
@@ -726,7 +703,7 @@ then restore the original execution context.Generated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/classes/Deque.html b/docs/classes/Deque.html index 080236b56..de90cc103 100644 --- a/docs/classes/Deque.html +++ b/docs/classes/Deque.html @@ -1,4 +1,4 @@ -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 incrementValue to append.
-The new size of the queue.
Value to prepend.
-The new size of the queue.
Generated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index f89a7b536..e284081d4 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,4 +1,4 @@ -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.
-Protected Readonly fileProtected Readonly maxProtected Readonly numberProtected Readonly optsProtected promiseProtected workerReadonly Internal workerProtected fullProtected maxProtected minPrivate readyProtected typePrivate utilizationProtected workerThe worker node key.
-The received message.
-Protected afterThe newly created worker node key.
-Protected beforeThe worker node key.
-The task to execute.
-Protected checkProtected createProtected createProtected createProtected destroyThe worker node key.
-Whether to enable or disable the worker node tasks queue.
-Optional tasksQueueOptions: TasksQueueOptionsThe worker node tasks queue options.
-Optional
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.
Protected flushProtected getThe worker node key.
-The worker information.
The worker node key.
-true if the worker node has back pressure, false otherwise.
Protected internalProtected isProtected registerThe worker node key.
-The message listener callback.
Protected sendProtected sendThe worker node key.
-Protected sendThe worker node key.
-The message.
-The worker node tasks queue options.
-The worker choice strategy.
-Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
-Optional
The worker choice strategy options.
-Protected setupProtected workerGenerated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index 6490be538..ec7c0cc1d 100644 --- a/docs/classes/DynamicThreadPool.html +++ b/docs/classes/DynamicThreadPool.html @@ -1,4 +1,4 @@ -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.
-Protected Readonly fileProtected Readonly maxProtected Readonly numberProtected Readonly optsProtected promiseProtected workerReadonly Internal workerProtected fullProtected maxProtected minPrivate readyProtected typePrivate utilizationProtected workerThe worker node key.
-The received message.
-Protected afterThe newly created worker node key.
-Protected beforeThe worker node key.
-The task to execute.
-Protected checkProtected createProtected createProtected createProtected destroyThe worker node key.
-Whether to enable or disable the worker node tasks queue.
-Optional tasksQueueOptions: TasksQueueOptionsThe worker node tasks queue options.
-Optional
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.
Protected flushProtected getThe worker node key.
-The worker information.
The worker node key.
-true if the worker node has back pressure, false otherwise.
Protected internalProtected isProtected registerThe worker node key.
-The message listener callback.
Protected sendProtected sendThe worker node key.
-Protected sendThe worker node key.
-The message.
-Optional transferList: TransferListItem[]The optional array of transferable objects.
-Optional
The worker node tasks queue options.
-The worker choice strategy.
-Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
-Optional
The worker choice strategy options.
-Protected setupProtected workerGenerated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index f5fb5b04c..e16a76ea3 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,4 +1,4 @@ -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.
-Protected Readonly fileProtected Optional Readonly maxProtected Readonly numberProtected Readonly optsProtected promiseProtected workerReadonly Internal workerProtected fullProtected maxProtected minPrivate readyProtected typePrivate utilizationProtected workerThe worker node key.
-The received message.
-Protected afterThe newly created worker node key.
-Protected beforeThe worker node key.
-The task to execute.
-Protected checkProtected createProtected createProtected createProtected destroyThe worker node key.
-Whether to enable or disable the worker node tasks queue.
-Optional tasksQueueOptions: TasksQueueOptionsThe worker node tasks queue options.
-Optional
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.
Protected flushProtected getThe worker node key.
-The worker information.
The worker node key.
-true if the worker node has back pressure, false otherwise.
Protected internalProtected isProtected registerThe worker node key.
-The message listener callback.
Protected sendProtected sendThe worker node key.
-Protected sendThe worker node key.
-The message.
-The worker node tasks queue options.
-The worker choice strategy.
-Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
-Optional
The worker choice strategy options.
-Protected setupProtected workerGenerated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index 4475fb574..0b08b110c 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -1,4 +1,4 @@ -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.
-Protected Readonly fileProtected Optional Readonly maxProtected Readonly numberProtected Readonly optsProtected promiseProtected workerReadonly Internal workerProtected fullProtected maxProtected minPrivate readyProtected typePrivate utilizationProtected workerThe worker node key.
-The received message.
-Protected afterThe newly created worker node key.
-Protected beforeThe worker node key.
-The task to execute.
-Protected checkProtected createProtected createProtected createProtected destroyThe worker node key.
-Whether to enable or disable the worker node tasks queue.
-Optional tasksQueueOptions: TasksQueueOptionsThe worker node tasks queue options.
-Optional
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.
Protected flushProtected getThe worker node key.
-The worker information.
The worker node key.
-true if the worker node has back pressure, false otherwise.
Protected internalProtected isProtected registerThe worker node key.
-The message listener callback.
Protected sendProtected sendThe worker node key.
-Protected sendThe worker node key.
-The message.
-Optional transferList: TransferListItem[]The optional array of transferable objects.
-Optional
The worker node tasks queue options.
-The worker choice strategy.
-Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
-Optional
The worker choice strategy options.
-Protected setupProtected workerGenerated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/classes/Node.html b/docs/classes/Node.html index 6f0feb7fa..edb5b1f4f 100644 --- a/docs/classes/Node.html +++ b/docs/classes/Node.html @@ -1,4 +1,4 @@ -Optional nextOptional prevGenerated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/classes/PoolEmitter.html b/docs/classes/PoolEmitter.html index 66bcc4f1f..3a95fd259 100644 --- a/docs/classes/PoolEmitter.html +++ b/docs/classes/PoolEmitter.html @@ -1,4 +1,4 @@ -Optional options: EventEmitterOptionsOptional options: EventEmitterOptionsOptional 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
@@ -308,7 +303,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 ...args: any[]Rest 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
@@ -568,18 +551,16 @@ 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 thisArg: ThisArgOptional
v14.8.0, v12.19.0
@@ -736,7 +713,7 @@ then restore the original execution context.Generated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/classes/WorkerChoiceStrategyContext.html b/docs/classes/WorkerChoiceStrategyContext.html index e1dc81a75..6b71c35ee 100644 --- a/docs/classes/WorkerChoiceStrategyContext.html +++ b/docs/classes/WorkerChoiceStrategyContext.html @@ -1,4 +1,4 @@ -The pool instance.
-The worker choice strategy.
-The worker choice strategy options.
-Private optsPrivate 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
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/functions/availableParallelism.html b/docs/functions/availableParallelism.html index ef33814d7..1dc24aaa8 100644 --- a/docs/functions/availableParallelism.html +++ b/docs/functions/availableParallelism.html @@ -1,4 +1,4 @@ -Generated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 64de48448..2767a1755 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,4 +1,4 @@ -Generated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/interfaces/ClusterPoolOptions.html b/docs/interfaces/ClusterPoolOptions.html index afa0379bf..b923963f4 100644 --- a/docs/interfaces/ClusterPoolOptions.html +++ b/docs/interfaces/ClusterPoolOptions.html @@ -1,4 +1,4 @@ -Pool events emission.
true
+true
+
Inherited from PoolOptions.enableEvents
Optional enablePool worker node tasks queue.
false
+false
+
Inherited 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 workerThe worker choice strategy to use in this pool.
WorkerChoiceStrategies.ROUND_ROBIN
+WorkerChoiceStrategies.ROUND_ROBIN
+
Inherited from PoolOptions.workerChoiceStrategy
Optional workerInherited from PoolOptions.workerChoiceStrategyOptions
Generated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/interfaces/EventLoopUtilizationMeasurementStatistics.html b/docs/interfaces/EventLoopUtilizationMeasurementStatistics.html index 896517659..0a98cff93 100644 --- a/docs/interfaces/EventLoopUtilizationMeasurementStatistics.html +++ b/docs/interfaces/EventLoopUtilizationMeasurementStatistics.html @@ -1,4 +1,4 @@ -Readonly activeReadonly idleOptional utilizationGenerated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 78d7a5444..e8b72506f 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,4 +1,4 @@ -Optional 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
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/interfaces/IWorker.html b/docs/interfaces/IWorker.html index 3eaa9a67c..aef63e6be 100644 --- a/docs/interfaces/IWorker.html +++ b/docs/interfaces/IWorker.html @@ -1,4 +1,4 @@ -Readonly onThe event handler.
Readonly onceThe 'exit' event.
The exit handler.
-Optional Readonly threadGenerated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/interfaces/IWorkerChoiceStrategy.html b/docs/interfaces/IWorkerChoiceStrategy.html index 5c896bc62..4cab7975a 100644 --- a/docs/interfaces/IWorkerChoiceStrategy.html +++ b/docs/interfaces/IWorkerChoiceStrategy.html @@ -1,4 +1,4 @@ -undefined 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
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/interfaces/IWorkerNode.html b/docs/interfaces/IWorkerNode.html index d5a723bc0..7f7dad3c8 100644 --- a/docs/interfaces/IWorkerNode.html +++ b/docs/interfaces/IWorkerNode.html @@ -1,4 +1,4 @@ -Readonly 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 onThe worker id.
-Optional onThe worker id.
-Readonly popReadonly resetReadonly tasksReadonly unshiftThe task to prepend.
-The tasks queue size.
Readonly workerGenerated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/interfaces/MeasurementOptions.html b/docs/interfaces/MeasurementOptions.html index 4a526856c..b01cb440c 100644 --- a/docs/interfaces/MeasurementOptions.html +++ b/docs/interfaces/MeasurementOptions.html @@ -1,4 +1,4 @@ -Generated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/interfaces/MeasurementStatistics.html b/docs/interfaces/MeasurementStatistics.html index 3ae1b047e..b39708e99 100644 --- a/docs/interfaces/MeasurementStatistics.html +++ b/docs/interfaces/MeasurementStatistics.html @@ -1,4 +1,4 @@ -Optional averageReadonly historyOptional maximumOptional medianOptional minimumGenerated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/interfaces/MeasurementStatisticsRequirements.html b/docs/interfaces/MeasurementStatisticsRequirements.html index 7827f4406..f785f5a72 100644 --- a/docs/interfaces/MeasurementStatisticsRequirements.html +++ b/docs/interfaces/MeasurementStatisticsRequirements.html @@ -1,4 +1,4 @@ -Generated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/interfaces/MessageValue.html b/docs/interfaces/MessageValue.html index ba6b58d06..aff8d80e1 100644 --- a/docs/interfaces/MessageValue.html +++ b/docs/interfaces/MessageValue.html @@ -1,4 +1,4 @@ -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
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/interfaces/PoolInfo.html b/docs/interfaces/PoolInfo.html index 48628fc5e..44be60c56 100644 --- a/docs/interfaces/PoolInfo.html +++ b/docs/interfaces/PoolInfo.html @@ -1,4 +1,4 @@ -Optional 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
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/interfaces/PoolOptions.html b/docs/interfaces/PoolOptions.html index a88cda7a8..cddcba3a9 100644 --- a/docs/interfaces/PoolOptions.html +++ b/docs/interfaces/PoolOptions.html @@ -1,4 +1,4 @@ -Pool events emission.
true
+true
+
Optional enablePool worker node tasks queue.
false
+false
+
Optional errorOptional exitOptional messageOptional onlineOptional restartOptional tasksOptional workerThe worker choice strategy to use in this pool.
WorkerChoiceStrategies.ROUND_ROBIN
+WorkerChoiceStrategies.ROUND_ROBIN
+
Optional workerGenerated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/interfaces/PromiseResponseWrapper.html b/docs/interfaces/PromiseResponseWrapper.html index 57ca3e4a1..e82d849ba 100644 --- a/docs/interfaces/PromiseResponseWrapper.html +++ b/docs/interfaces/PromiseResponseWrapper.html @@ -1,4 +1,4 @@ -Optional reason: unknownOptional reason: unknownOptional Readonly resolveReadonly workerGenerated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/interfaces/StrategyPolicy.html b/docs/interfaces/StrategyPolicy.html index 72a2718b7..1c180608b 100644 --- a/docs/interfaces/StrategyPolicy.html +++ b/docs/interfaces/StrategyPolicy.html @@ -1,4 +1,4 @@ -Readonly dynamicGenerated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/interfaces/Task.html b/docs/interfaces/Task.html index 0a6eabf0a..b5b41a2a0 100644 --- a/docs/interfaces/Task.html +++ b/docs/interfaces/Task.html @@ -1,4 +1,4 @@ -Optional Readonly nameOptional Readonly taskOptional Readonly timestampOptional Readonly transferReadonly workerGenerated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/interfaces/TaskError.html b/docs/interfaces/TaskError.html index 4cc4423ba..b646d0a46 100644 --- a/docs/interfaces/TaskError.html +++ b/docs/interfaces/TaskError.html @@ -1,4 +1,4 @@ -Readonly messageReadonly nameGenerated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/interfaces/TaskPerformance.html b/docs/interfaces/TaskPerformance.html index d1154aa72..f162a5591 100644 --- a/docs/interfaces/TaskPerformance.html +++ b/docs/interfaces/TaskPerformance.html @@ -1,4 +1,4 @@ -Readonly nameOptional Readonly runReadonly timestampGenerated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/interfaces/TaskStatistics.html b/docs/interfaces/TaskStatistics.html index 3c82a3d33..1fc77051e 100644 --- a/docs/interfaces/TaskStatistics.html +++ b/docs/interfaces/TaskStatistics.html @@ -1,4 +1,4 @@ -Optional Readonly maxReadonly queuedGenerated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/interfaces/TaskStatisticsRequirements.html b/docs/interfaces/TaskStatisticsRequirements.html index cbb7d87c7..bbb3b672c 100644 --- a/docs/interfaces/TaskStatisticsRequirements.html +++ b/docs/interfaces/TaskStatisticsRequirements.html @@ -1,4 +1,4 @@ -Readonly runReadonly waitGenerated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/interfaces/TasksQueueOptions.html b/docs/interfaces/TasksQueueOptions.html index d6c19b181..53baab1c9 100644 --- a/docs/interfaces/TasksQueueOptions.html +++ b/docs/interfaces/TasksQueueOptions.html @@ -1,4 +1,4 @@ -Maximum number of tasks that can be executed concurrently on a worker node.
1
+1
+
Optional Readonly queueUse size instead.
Optional Readonly sizeMaximum tasks queue size per worker node flagging it as back pressured.
(pool maximum size)^2
+(pool maximum size)^2
+
Generated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/interfaces/ThreadPoolOptions.html b/docs/interfaces/ThreadPoolOptions.html index 4f422435c..d4665dce7 100644 --- a/docs/interfaces/ThreadPoolOptions.html +++ b/docs/interfaces/ThreadPoolOptions.html @@ -1,4 +1,4 @@ -Pool events emission.
true
+true
+
Inherited from PoolOptions.enableEvents
Optional enablePool worker node tasks queue.
false
+false
+
Inherited 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 workerThe worker choice strategy to use in this pool.
WorkerChoiceStrategies.ROUND_ROBIN
+WorkerChoiceStrategies.ROUND_ROBIN
+
Inherited from PoolOptions.workerChoiceStrategy
Optional workerInherited from PoolOptions.workerChoiceStrategyOptions
Optional workerhttps://nodejs.org/api/worker_threads.html#new-workerfilename-options
Generated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/interfaces/WorkerChoiceStrategyOptions.html b/docs/interfaces/WorkerChoiceStrategyOptions.html index e205258c2..9e37496a6 100644 --- a/docs/interfaces/WorkerChoiceStrategyOptions.html +++ b/docs/interfaces/WorkerChoiceStrategyOptions.html @@ -1,4 +1,4 @@ -Number of worker choice retries to perform if no worker is eligible.
6
+6
+
Optional Readonly eluEvent loop utilization options.
{ median: false }
+{ median: false }
+
Optional Readonly measurementOptional Readonly runRuntime options.
{ median: false }
+{ median: false }
+
Optional Readonly waitWait time options.
{ median: false }
+{ median: false }
+
Optional Readonly weightsWeights computed automatically given the CPU performance.
+Weights computed automatically given the CPU performance.
+
Generated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/interfaces/WorkerInfo.html b/docs/interfaces/WorkerInfo.html index b95bd38ee..3e485bc4c 100644 --- a/docs/interfaces/WorkerInfo.html +++ b/docs/interfaces/WorkerInfo.html @@ -1,4 +1,4 @@ -Readonly idOptional taskGenerated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/interfaces/WorkerOptions.html b/docs/interfaces/WorkerOptions.html index fc9060daa..90a60737d 100644 --- a/docs/interfaces/WorkerOptions.html +++ b/docs/interfaces/WorkerOptions.html @@ -1,4 +1,4 @@ -Whether your worker will perform asynchronous or not.
false
+false
+
This option will be removed in the next major version.
Optional killThis option only apply to the newly created workers.
KillBehaviors.SOFT
+KillBehaviors.SOFT
+
Optional killOptional max60000
+60000
+
Generated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/interfaces/WorkerStatistics.html b/docs/interfaces/WorkerStatistics.html index 8cb8d465d..bb10df2e9 100644 --- a/docs/interfaces/WorkerStatistics.html +++ b/docs/interfaces/WorkerStatistics.html @@ -1,4 +1,4 @@ -Generated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/interfaces/WorkerUsage.html b/docs/interfaces/WorkerUsage.html index d045c56c6..70444af35 100644 --- a/docs/interfaces/WorkerUsage.html +++ b/docs/interfaces/WorkerUsage.html @@ -1,4 +1,4 @@ -Readonly runReadonly tasksReadonly waitGenerated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/types/ErrorHandler.html b/docs/types/ErrorHandler.html index f31541344..6cc21a343 100644 --- a/docs/types/ErrorHandler.html +++ b/docs/types/ErrorHandler.html @@ -1,4 +1,4 @@ -Generated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/types/ExitHandler.html b/docs/types/ExitHandler.html index 7f215f647..76e56f918 100644 --- a/docs/types/ExitHandler.html +++ b/docs/types/ExitHandler.html @@ -1,4 +1,4 @@ -Generated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/types/KillBehavior.html b/docs/types/KillBehavior.html index 89b55f28a..ade0a1ce8 100644 --- a/docs/types/KillBehavior.html +++ b/docs/types/KillBehavior.html @@ -1,4 +1,4 @@ -Generated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/types/KillHandler.html b/docs/types/KillHandler.html index 571c7c4da..1ad0e8956 100644 --- a/docs/types/KillHandler.html +++ b/docs/types/KillHandler.html @@ -1,4 +1,4 @@ -Generated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/types/Measurement.html b/docs/types/Measurement.html index 8ab3bf2df..6f788d2c4 100644 --- a/docs/types/Measurement.html +++ b/docs/types/Measurement.html @@ -1,4 +1,4 @@ -Generated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/types/MessageHandler.html b/docs/types/MessageHandler.html index 16a213b1b..d115f8a54 100644 --- a/docs/types/MessageHandler.html +++ b/docs/types/MessageHandler.html @@ -1,4 +1,4 @@ -Generated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/types/OnlineHandler.html b/docs/types/OnlineHandler.html index b5a060ace..8702dd15d 100644 --- a/docs/types/OnlineHandler.html +++ b/docs/types/OnlineHandler.html @@ -1,4 +1,4 @@ -Generated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/types/PoolEvent.html b/docs/types/PoolEvent.html index 728c8e654..ac002ae68 100644 --- a/docs/types/PoolEvent.html +++ b/docs/types/PoolEvent.html @@ -1,4 +1,4 @@ -Generated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/types/PoolType.html b/docs/types/PoolType.html index fd6b05172..77706da20 100644 --- a/docs/types/PoolType.html +++ b/docs/types/PoolType.html @@ -1,4 +1,4 @@ -Generated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/types/TaskAsyncFunction.html b/docs/types/TaskAsyncFunction.html index aca74c65c..73d5e9b66 100644 --- a/docs/types/TaskAsyncFunction.html +++ b/docs/types/TaskAsyncFunction.html @@ -1,4 +1,4 @@ -Optional data: DataOptional data: DataOptional Generated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/types/TaskFunction.html b/docs/types/TaskFunction.html index 865bfd800..4fd524fb8 100644 --- a/docs/types/TaskFunction.html +++ b/docs/types/TaskFunction.html @@ -1,4 +1,4 @@ -Generated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/types/TaskFunctions.html b/docs/types/TaskFunctions.html index aaaada177..242842767 100644 --- a/docs/types/TaskFunctions.html +++ b/docs/types/TaskFunctions.html @@ -1,4 +1,4 @@ -Generated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/types/TaskSyncFunction.html b/docs/types/TaskSyncFunction.html index fe3be1499..66f99cdd2 100644 --- a/docs/types/TaskSyncFunction.html +++ b/docs/types/TaskSyncFunction.html @@ -1,4 +1,4 @@ -Optional data: DataOptional data: DataOptional Generated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/types/WorkerChoiceStrategy.html b/docs/types/WorkerChoiceStrategy.html index 42745663a..3f4bebb1c 100644 --- a/docs/types/WorkerChoiceStrategy.html +++ b/docs/types/WorkerChoiceStrategy.html @@ -1,4 +1,4 @@ -Generated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/types/WorkerType.html b/docs/types/WorkerType.html index 69e25ab7d..5657822cf 100644 --- a/docs/types/WorkerType.html +++ b/docs/types/WorkerType.html @@ -1,4 +1,4 @@ -Generated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/types/Writable.html b/docs/types/Writable.html index 88a4062e1..c87ff143c 100644 --- a/docs/types/Writable.html +++ b/docs/types/Writable.html @@ -1,4 +1,4 @@ -Generated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/variables/KillBehaviors.html b/docs/variables/KillBehaviors.html index d44ce858a..812bf8c65 100644 --- a/docs/variables/KillBehaviors.html +++ b/docs/variables/KillBehaviors.html @@ -1,4 +1,4 @@ -Generated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/variables/Measurements.html b/docs/variables/Measurements.html index 4c35bd512..8f4b6db38 100644 --- a/docs/variables/Measurements.html +++ b/docs/variables/Measurements.html @@ -1,4 +1,4 @@ -Readonly waitGenerated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/variables/PoolEvents.html b/docs/variables/PoolEvents.html index 6f4f1beb4..3be6a4acc 100644 --- a/docs/variables/PoolEvents.html +++ b/docs/variables/PoolEvents.html @@ -1,4 +1,4 @@ -Readonly taskGenerated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/variables/PoolTypes.html b/docs/variables/PoolTypes.html index 8d2567405..fb3631c03 100644 --- a/docs/variables/PoolTypes.html +++ b/docs/variables/PoolTypes.html @@ -1,4 +1,4 @@ -Generated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/variables/WorkerChoiceStrategies.html b/docs/variables/WorkerChoiceStrategies.html index 14a3cc43c..e2eb4014f 100644 --- a/docs/variables/WorkerChoiceStrategies.html +++ b/docs/variables/WorkerChoiceStrategies.html @@ -1,4 +1,4 @@ -Generated using TypeDoc
Generated using TypeDoc
\ No newline at end of file diff --git a/docs/variables/WorkerTypes.html b/docs/variables/WorkerTypes.html index e5d5b2c2c..dd4b7bca0 100644 --- a/docs/variables/WorkerTypes.html +++ b/docs/variables/WorkerTypes.html @@ -1,4 +1,4 @@ -Readonly thread: "thread"Generated using TypeDoc
Generated using TypeDoc
\ No newline at end of file -- 2.43.0
Number of workers that this pool should manage.
-