From 1d9f69fa27366fd18f2600beeee89187306df22a Mon Sep 17 00:00:00 2001
From: "github-actions[bot]"
<41898282+github-actions[bot]@users.noreply.github.com>
Date: Sun, 13 Aug 2023 20:46:57 +0000
Subject: [PATCH] chore: generate documentation
---
docs/classes/AbstractPool.html | 150 +++++++++---------
docs/classes/AbstractWorker.html | 86 +++++-----
docs/classes/CircularArray.html | 28 ++--
docs/classes/ClusterWorker.html | 64 ++++----
docs/classes/DynamicClusterPool.html | 90 +++++------
docs/classes/DynamicThreadPool.html | 90 +++++------
docs/classes/FixedClusterPool.html | 88 +++++-----
docs/classes/FixedThreadPool.html | 88 +++++-----
docs/classes/PoolEmitter.html | 108 +++++++++----
docs/classes/Queue.html | 28 ++--
docs/classes/ThreadWorker.html | 66 ++++----
docs/classes/WorkerChoiceStrategyContext.html | 28 ++--
docs/functions/availableParallelism.html | 8 +-
docs/index.html | 8 +-
docs/interfaces/ClusterPoolOptions.html | 32 ++--
...tLoopUtilizationMeasurementStatistics.html | 14 +-
docs/interfaces/IPool.html | 26 +--
docs/interfaces/IWorker.html | 16 +-
docs/interfaces/IWorkerChoiceStrategy.html | 22 +--
docs/interfaces/IWorkerNode.html | 28 ++--
docs/interfaces/MeasurementOptions.html | 10 +-
docs/interfaces/MeasurementStatistics.html | 20 +--
.../MeasurementStatisticsRequirements.html | 14 +-
docs/interfaces/MessageValue.html | 34 ++--
docs/interfaces/PoolInfo.html | 44 ++---
docs/interfaces/PoolOptions.html | 28 ++--
docs/interfaces/PromiseResponseWrapper.html | 14 +-
docs/interfaces/StrategyPolicy.html | 10 +-
docs/interfaces/Task.html | 20 +--
docs/interfaces/TaskError.html | 14 +-
docs/interfaces/TaskPerformance.html | 16 +-
docs/interfaces/TaskStatistics.html | 18 +--
.../TaskStatisticsRequirements.html | 14 +-
docs/interfaces/TasksQueueOptions.html | 10 +-
docs/interfaces/ThreadPoolOptions.html | 30 ++--
.../WorkerChoiceStrategyOptions.html | 18 +--
docs/interfaces/WorkerInfo.html | 18 +--
docs/interfaces/WorkerOptions.html | 14 +-
docs/interfaces/WorkerStatistics.html | 12 +-
docs/interfaces/WorkerUsage.html | 16 +-
docs/types/ErrorHandler.html | 8 +-
docs/types/ExitHandler.html | 8 +-
docs/types/KillBehavior.html | 8 +-
docs/types/Measurement.html | 8 +-
docs/types/MessageHandler.html | 8 +-
docs/types/OnlineHandler.html | 8 +-
docs/types/PoolEvent.html | 8 +-
docs/types/PoolType.html | 8 +-
docs/types/TaskAsyncFunction.html | 8 +-
docs/types/TaskFunction.html | 8 +-
docs/types/TaskFunctions.html | 8 +-
docs/types/TaskSyncFunction.html | 8 +-
docs/types/WorkerChoiceStrategy.html | 8 +-
docs/types/WorkerType.html | 8 +-
docs/variables/KillBehaviors.html | 8 +-
docs/variables/Measurements.html | 8 +-
docs/variables/PoolEvents.html | 8 +-
docs/variables/PoolTypes.html | 8 +-
docs/variables/WorkerChoiceStrategies.html | 8 +-
docs/variables/WorkerTypes.html | 8 +-
60 files changed, 824 insertions(+), 778 deletions(-)
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 5d9c47e5..fed14871 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,4 +1,4 @@
-
AbstractPool | poolifier - v2.6.24
+AbstractPool | poolifier - v2.6.25
@@ -49,7 +49,7 @@
IPool < Worker , Data , Response >
+
Defined in src/pools/abstract-pool.ts:56
@@ -177,7 +177,7 @@
Returns AbstractPool < Worker , Data , Response >
+
Defined in src/pools/abstract-pool.ts:103
Protected
Readonly
file Path
file Path : string
@@ -204,7 +204,7 @@
+
Defined in src/pools/abstract-pool.ts:105
Protected
Readonly
number Of Workers
number Of Workers : number
@@ -212,7 +212,7 @@
+Defined in src/pools/abstract-pool.ts:104
Protected
Readonly
opts
@@ -220,7 +220,7 @@
+Defined in src/pools/abstract-pool.ts:106
Protected
promise Response Map
@@ -233,7 +233,7 @@
+Defined in src/pools/abstract-pool.ts:75
Private
Readonly
start Timestamp
start Timestamp : number
@@ -241,7 +241,7 @@
+Defined in src/pools/abstract-pool.ts:94
Private
Readonly
starting
starting : boolean
@@ -249,7 +249,7 @@
+Defined in src/pools/abstract-pool.ts:90
Protected
worker Choice Strategy Context
@@ -257,7 +257,7 @@
+Defined in src/pools/abstract-pool.ts:81
Readonly
worker Nodes
@@ -266,7 +266,7 @@
+Defined in src/pools/abstract-pool.ts:62
Protected
full
@@ -292,7 +292,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:607
+Defined in src/pools/abstract-pool.ts:302
Protected
Abstract
max Size
@@ -315,7 +315,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:498
Protected
Abstract
min Size
@@ -326,7 +326,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:493
Private
ready
@@ -337,7 +337,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:445
Protected
Abstract
type
@@ -349,7 +349,7 @@
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:483
+Defined in src/pools/abstract-pool.ts:462
Protected
Abstract
worker
@@ -372,7 +372,7 @@
Returns "thread" | "cluster"
+Defined in src/pools/abstract-pool.ts:488
Protected
after Task Execution Hook
@@ -421,7 +421,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:745
Protected
after Worker Node Setup
@@ -441,7 +441,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:976
Protected
before Task Execution Hook
@@ -466,7 +466,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:724
Private
build Tasks Queue Options
@@ -479,7 +479,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:594
Private
check And Emit Events
@@ -487,7 +487,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1110
Protected
check Dynamic Pool Size
@@ -502,7 +502,7 @@ Can be overridden.
max : number
Returns void
+Defined in src/pools/abstract-pool.ts:174
Private
check File Path
@@ -515,7 +515,7 @@ Can be overridden.
filePath : string
Returns void
+Defined in src/pools/abstract-pool.ts:143
Private
check Message Worker Id
+Defined in src/pools/abstract-pool.ts:506
Private
check Number Of Workers
@@ -549,7 +549,7 @@ Can be overridden.
numberOfWorkers : number
Returns void
+Defined in src/pools/abstract-pool.ts:156
Private
check Pool Options
@@ -562,7 +562,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:200
Private
check Valid Tasks Queue Options
@@ -575,7 +575,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:265
Private
check Valid Worker Choice Strategy
@@ -588,7 +588,7 @@ Can be overridden.
workerChoiceStrategy : "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
Returns void
+Defined in src/pools/abstract-pool.ts:227
Private
check Valid Worker Choice Strategy Options
@@ -601,7 +601,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:237
Private
choose Worker Node
@@ -614,7 +614,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:839
Protected
create And Setup Dynamic Worker Node
@@ -626,7 +626,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:925
Protected
create And Setup Worker Node
@@ -638,7 +638,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:885
Protected
Abstract
create Worker
@@ -650,7 +650,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:878
Private
dequeue Task
@@ -663,7 +663,7 @@ Can be overridden.
workerNodeKey : number
Returns undefined | Task < Data >
+Defined in src/pools/abstract-pool.ts:1180
+Defined in src/pools/abstract-pool.ts:687
Protected
Abstract
destroy Worker Node
@@ -694,7 +694,7 @@ Can be overridden.
Returns Promise < void >
+Defined in src/pools/abstract-pool.ts:700
+Defined in src/pools/abstract-pool.ts:572
Private
enqueue Task
@@ -734,7 +734,7 @@ Can be overridden.
task : Task < Data >
Returns number
+Defined in src/pools/abstract-pool.ts:1176
+Defined in src/pools/abstract-pool.ts:644
Private
execute Task
@@ -789,7 +789,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1171
Protected
flush Tasks Queue
@@ -802,7 +802,7 @@ Can be overridden.
workerNodeKey : number
Returns void
+Defined in src/pools/abstract-pool.ts:1188
Private
flush Tasks Queues
@@ -810,7 +810,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1198
Protected
get Worker Info
@@ -830,7 +830,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1127
Private
get Worker Node Key By Worker
@@ -850,7 +850,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:523
Private
get Worker Node Key By Worker Id
@@ -870,7 +870,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:535
Private
handle Task Execution Response
@@ -883,7 +883,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1081
Private
handle Worker Ready Response
@@ -896,7 +896,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1072
Protected
internal Busy
@@ -908,7 +908,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:623
Protected
Abstract
is Main
@@ -919,7 +919,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:715
Private
redistribute Queued Tasks
@@ -932,7 +932,7 @@ Can be overridden.
workerNodeKey : number
Returns void
+Defined in src/pools/abstract-pool.ts:1010
Protected
Abstract
register Worker Message Listener
@@ -972,7 +972,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:963
Private
remove Worker Node
@@ -991,7 +991,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1157
Protected
Abstract
send Startup Message To Worker
@@ -1010,7 +1010,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:990
Protected
Abstract
send To Worker
@@ -1039,7 +1039,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:867
Private
send Worker Statistics Message To Worker
@@ -1058,7 +1058,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:997
+Defined in src/pools/abstract-pool.ts:584
+Defined in src/pools/abstract-pool.ts:542
set Worker Choice Strategy Options
+Defined in src/pools/abstract-pool.ts:561
Protected
setup Hook
@@ -1135,7 +1135,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:708
Private
shall Create Dynamic Worker
@@ -1147,7 +1147,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:856
Private
start Pool
@@ -1155,7 +1155,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:289
Private
tasks Queue Size
@@ -1168,7 +1168,7 @@ Can be overridden.
workerNodeKey : number
Returns number
+Defined in src/pools/abstract-pool.ts:1184
Private
update Elu Worker Usage
@@ -1183,7 +1183,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:800
Private
update Run Time Worker Usage
@@ -1198,7 +1198,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:774
Private
update Task Statistics Worker Usage
@@ -1213,7 +1213,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:761
Private
update Wait Time Worker Usage
@@ -1228,7 +1228,7 @@ Can be overridden.
task : Task < Data >
Returns void
+Defined in src/pools/abstract-pool.ts:786
Protected
worker Listener
@@ -1255,7 +1255,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1059
+
Defined in src/worker/abstract-worker.ts:63
Protected
Abstract
id
id : number
@@ -169,7 +169,7 @@
+Defined in src/worker/abstract-worker.ts:47
Protected
Readonly
is Main
is Main : boolean
@@ -177,7 +177,7 @@
+Defined in src/worker/abstract-worker.ts:75
Protected
last Task Timestamp
last Task Timestamp : number
@@ -185,7 +185,7 @@
+Defined in src/worker/abstract-worker.ts:55
Private
Readonly
main Worker
main Worker : MainWorker
@@ -193,7 +193,7 @@
+Defined in src/worker/abstract-worker.ts:76
Protected
Readonly
opts
@@ -201,7 +201,7 @@
+Defined in src/worker/abstract-worker.ts:78
Protected
statistics
@@ -209,7 +209,7 @@
+Defined in src/worker/abstract-worker.ts:59
Protected
task Functions
@@ -217,7 +217,7 @@
+Defined in src/worker/abstract-worker.ts:51
+Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/async_hooks.d.ts:306
Private
begin Task Performance
@@ -275,7 +275,7 @@ If a task function with the same name already exists, it is replaced.
Optional
name : string
+Defined in src/worker/abstract-worker.ts:501
+Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/async_hooks.d.ts:283
Private
check Active
@@ -313,7 +313,7 @@ If a task function with the same name already exists, it is replaced.
Returns void
+Defined in src/worker/abstract-worker.ts:351
Private
check Statistics
@@ -321,7 +321,7 @@ If a task function with the same name already exists, it is replaced.
Returns void
+Defined in src/worker/abstract-worker.ts:525
Private
check Task Functions
@@ -340,7 +340,7 @@ If a task function with the same name already exists, it is replaced.
Returns void
+Defined in src/worker/abstract-worker.ts:110
Private
check Worker Options
@@ -353,7 +353,7 @@ If a task function with the same name already exists, it is replaced.
Returns void
+Defined in src/worker/abstract-worker.ts:98
+Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/async_hooks.d.ts:302
Private
end Task Performance
@@ -382,7 +382,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:510
Protected
get Main Worker
@@ -394,7 +394,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:365
+Defined in src/worker/abstract-worker.ts:492
Protected
handle Error
@@ -436,7 +436,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:387
Protected
handle Kill Message
@@ -455,7 +455,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:322
Protected
Abstract
handle Ready Message
@@ -474,7 +474,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:288
+Defined in src/worker/abstract-worker.ts:164
list Task Functions
@@ -508,7 +508,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:245
Protected
message Listener
@@ -527,7 +527,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:295
+Defined in src/worker/abstract-worker.ts:221
+Defined in src/worker/abstract-worker.ts:397
Protected
run Async
@@ -598,7 +598,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:451
+Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/async_hooks.d.ts:294
Protected
run Sync
@@ -677,7 +677,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:415
Protected
Abstract
send To Main Worker
@@ -696,7 +696,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:377
+Defined in src/worker/abstract-worker.ts:258
Private
start Check Active
@@ -733,7 +733,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:330
Private
stop Check Active
@@ -744,7 +744,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:341
+Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/async_hooks.d.ts:311
Private
update Last Task Timestamp
@@ -763,7 +763,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:531
+Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/async_hooks.d.ts:277
@@ -31,7 +31,7 @@
+
Defined in src/circular-array.ts:8
+
Defined in src/circular-array.ts:11
Properties
@@ -153,7 +153,7 @@ when they will be absent when used in a 'with' statement.
size
size : number
+Defined in src/circular-array.ts:9
Static
Readonly
[species]
[species] : ArrayConstructor
@@ -206,7 +206,7 @@ when they will be absent when used in a 'with' statement.
size : number
Returns void
+
Defined in src/circular-array.ts:98
concat
@@ -222,7 +222,7 @@ when they will be absent when used in a 'with' statement.
Inherit Doc
+Defined in src/circular-array.ts:39
copy Within
@@ -263,7 +263,7 @@ is treated as length+end. If start is omitted, 0
is used.
Returns boolean
+Defined in src/circular-array.ts:90
entries
@@ -729,7 +729,7 @@ thisArg is omitted, undefined is used as the this value.
Returns boolean
+Defined in src/circular-array.ts:94
includes
@@ -910,7 +910,7 @@ If the array is empty, undefined is returned and the array is not modified.
Inherit Doc
+Defined in src/circular-array.ts:21
reduce
@@ -1145,7 +1145,7 @@ If the array is empty, undefined is returned and the array is not modified.
size : number
Returns void
+Defined in src/circular-array.ts:78
reverse
@@ -1301,7 +1301,7 @@ value otherwise. If omitted, the elements are sorted in ascending, ASCII charact
Inherit Doc
+Defined in src/circular-array.ts:54
to Locale String
@@ -1341,7 +1341,7 @@ value otherwise. If omitted, the elements are sorted in ascending, ASCII charact
Inherit Doc
+Defined in src/circular-array.ts:30
values
@@ -1599,7 +1599,7 @@ value otherwise. If omitted, the elements are sorted in ascending, ASCII charact
is Array
of
@@ -47,7 +47,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/cluster-worker.ts:21
@@ -126,7 +126,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/cluster-worker.ts:31
Protected
Readonly
is Main
is Main : boolean
@@ -146,7 +146,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:75
Protected
last Task Timestamp
last Task Timestamp : number
@@ -155,7 +155,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:55
Protected
Readonly
opts
@@ -164,7 +164,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:78
Protected
statistics
@@ -173,7 +173,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:59
Protected
task Functions
@@ -182,7 +182,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:51
Accessors
@@ -196,7 +196,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/cluster-worker.ts:53
Methods
@@ -231,7 +231,7 @@ If a task function with the same name already exists, it is replaced.
+
Defined in src/worker/abstract-worker.ts:182
+
Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/async_hooks.d.ts:306
bind
@@ -269,7 +269,7 @@ If a task function with the same name already exists, it is replaced.
+Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/async_hooks.d.ts:283
+Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/async_hooks.d.ts:302
+Defined in src/worker/abstract-worker.ts:365
+Defined in src/worker/abstract-worker.ts:387
Protected
handle Kill Message
+Defined in src/worker/abstract-worker.ts:322
Protected
handle Ready Message
+Defined in src/worker/cluster-worker.ts:45
+Defined in src/worker/abstract-worker.ts:164
+Defined in src/worker/abstract-worker.ts:245
Protected
message Listener
+Defined in src/worker/abstract-worker.ts:295
+Defined in src/worker/abstract-worker.ts:221
+Defined in src/worker/abstract-worker.ts:397
+Defined in src/worker/abstract-worker.ts:451
+Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/async_hooks.d.ts:294
+Defined in src/worker/abstract-worker.ts:415
Protected
send To Main Worker
+Defined in src/worker/cluster-worker.ts:58
+Defined in src/worker/abstract-worker.ts:258
+Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/async_hooks.d.ts:311
+Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/async_hooks.d.ts:277
@@ -45,7 +45,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+
Defined in src/pools/cluster/dynamic.ts:15
@@ -147,7 +147,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+
Defined in src/pools/cluster/dynamic.ts:27
Properties
@@ -166,7 +166,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+Defined in src/pools/abstract-pool.ts:65
Protected
Readonly
file Path
file Path : string
@@ -175,7 +175,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:105
Protected
Readonly
max
max : number
@@ -183,7 +183,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+
Defined in src/pools/cluster/dynamic.ts:29
Protected
Readonly
number Of Workers
number Of Workers : number
@@ -192,7 +192,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:104
Protected
Readonly
opts
@@ -201,7 +201,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+
Defined in src/pools/cluster/fixed.ts:47
Protected
promise Response Map
@@ -215,7 +215,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:75
Protected
worker Choice Strategy Context
@@ -224,7 +224,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:81
Readonly
worker Nodes
@@ -233,7 +233,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:62
+
Defined in src/pools/abstract-pool.ts:607
+
Defined in src/pools/abstract-pool.ts:302
+
Defined in src/pools/cluster/dynamic.ts:43
+
Defined in src/pools/cluster/fixed.ts:120
+
Defined in src/pools/abstract-pool.ts:445
+
Defined in src/pools/cluster/dynamic.ts:38
+
Defined in src/pools/abstract-pool.ts:462
+
Defined in src/pools/cluster/fixed.ts:115
Protected
after Worker Node Setup
+
Defined in src/pools/abstract-pool.ts:976
Protected
before Task Execution Hook
+
Defined in src/pools/abstract-pool.ts:724
Protected
check Dynamic Pool Size
+
Defined in src/pools/abstract-pool.ts:174
Protected
create And Setup Dynamic Worker Node
+
Defined in src/pools/abstract-pool.ts:925
Protected
create And Setup Worker Node
+
Defined in src/pools/abstract-pool.ts:885
+
Defined in src/pools/cluster/fixed.ts:105
+
Defined in src/pools/abstract-pool.ts:687
Protected
destroy Worker Node
+
Defined in src/pools/cluster/fixed.ts:63
+
Defined in src/pools/abstract-pool.ts:572
+
Defined in src/pools/abstract-pool.ts:644
Protected
flush Tasks Queue
+
Defined in src/pools/abstract-pool.ts:1188
+
Defined in src/pools/abstract-pool.ts:1127
+
Defined in src/pools/abstract-pool.ts:623
+
Defined in src/pools/cluster/fixed.ts:58
Protected
register Worker Message Listener
+
Defined in src/pools/cluster/fixed.ts:97
Protected
send Startup Message To Worker
+
Defined in src/pools/cluster/fixed.ts:89
+
Defined in src/pools/cluster/fixed.ts:81
+
Defined in src/pools/abstract-pool.ts:584
+
Defined in src/pools/abstract-pool.ts:542
set Worker Choice Strategy Options
+
Defined in src/pools/abstract-pool.ts:561
+
Defined in src/pools/cluster/fixed.ts:53
+Defined in src/pools/abstract-pool.ts:1059
@@ -45,7 +45,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+
Defined in src/pools/thread/dynamic.ts:15
@@ -147,7 +147,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+
Defined in src/pools/thread/dynamic.ts:27
Properties
@@ -166,7 +166,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+Defined in src/pools/abstract-pool.ts:65
Protected
Readonly
file Path
file Path : string
@@ -175,7 +175,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:105
Protected
Readonly
max
max : number
@@ -183,7 +183,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+
Defined in src/pools/thread/dynamic.ts:29
Protected
Readonly
number Of Workers
number Of Workers : number
@@ -192,7 +192,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:104
Protected
Readonly
opts
@@ -201,7 +201,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+
Defined in src/pools/thread/fixed.ts:49
Protected
promise Response Map
@@ -215,7 +215,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:75
Protected
worker Choice Strategy Context
@@ -224,7 +224,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:81
Readonly
worker Nodes
@@ -233,7 +233,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:62
Accessors
@@ -248,7 +248,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+Defined in src/pools/thread/dynamic.ts:48
+
Defined in src/pools/abstract-pool.ts:607
+
Defined in src/pools/abstract-pool.ts:302
+
Defined in src/pools/thread/dynamic.ts:43
+
Defined in src/pools/thread/fixed.ts:132
+
Defined in src/pools/abstract-pool.ts:445
+
Defined in src/pools/thread/dynamic.ts:38
+
Defined in src/pools/abstract-pool.ts:462
+
Defined in src/pools/thread/fixed.ts:127
Protected
after Worker Node Setup
+
Defined in src/pools/abstract-pool.ts:976
Protected
before Task Execution Hook
+
Defined in src/pools/abstract-pool.ts:724
Protected
check Dynamic Pool Size
+
Defined in src/pools/abstract-pool.ts:174
Protected
create And Setup Dynamic Worker Node
+
Defined in src/pools/abstract-pool.ts:925
Protected
create And Setup Worker Node
+
Defined in src/pools/abstract-pool.ts:885
+
Defined in src/pools/thread/fixed.ts:114
+
Defined in src/pools/abstract-pool.ts:687
Protected
destroy Worker Node
+
Defined in src/pools/thread/fixed.ts:60
+
Defined in src/pools/abstract-pool.ts:572
+
Defined in src/pools/abstract-pool.ts:644
Protected
flush Tasks Queue
+
Defined in src/pools/abstract-pool.ts:1188
+
Defined in src/pools/abstract-pool.ts:1127
+
Defined in src/pools/abstract-pool.ts:623
+
Defined in src/pools/thread/fixed.ts:55
Protected
register Worker Message Listener
+
Defined in src/pools/thread/fixed.ts:104
Protected
send Startup Message To Worker
+
Defined in src/pools/thread/fixed.ts:88
+
Defined in src/pools/thread/fixed.ts:77
+
Defined in src/pools/abstract-pool.ts:584
+
Defined in src/pools/abstract-pool.ts:542
set Worker Choice Strategy Options
+
Defined in src/pools/abstract-pool.ts:561
+
Defined in src/pools/abstract-pool.ts:708
+Defined in src/pools/abstract-pool.ts:1059
@@ -45,7 +45,7 @@
+
Defined in src/pools/cluster/fixed.ts:33
+
Defined in src/pools/cluster/fixed.ts:44
Protected
Readonly
file Path
file Path : string
@@ -169,7 +169,7 @@
+
Defined in src/pools/abstract-pool.ts:105
Protected
Readonly
number Of Workers
number Of Workers : number
@@ -178,7 +178,7 @@
+
Defined in src/pools/abstract-pool.ts:104
Protected
Readonly
opts
@@ -187,7 +187,7 @@
+
Defined in src/pools/cluster/fixed.ts:47
Protected
promise Response Map
@@ -201,7 +201,7 @@
+
Defined in src/pools/abstract-pool.ts:75
Protected
worker Choice Strategy Context
@@ -210,7 +210,7 @@
+
Defined in src/pools/abstract-pool.ts:81
Readonly
worker Nodes
@@ -219,7 +219,7 @@
+
Defined in src/pools/abstract-pool.ts:62
+
Defined in src/pools/abstract-pool.ts:607
+
Defined in src/pools/abstract-pool.ts:302
+
Defined in src/pools/cluster/fixed.ts:125
+
Defined in src/pools/cluster/fixed.ts:120
+
Defined in src/pools/abstract-pool.ts:445
+
Defined in src/pools/cluster/fixed.ts:110
+
Defined in src/pools/abstract-pool.ts:462
+
Defined in src/pools/cluster/fixed.ts:115
Protected
after Worker Node Setup
+
Defined in src/pools/abstract-pool.ts:976
Protected
before Task Execution Hook
+
Defined in src/pools/abstract-pool.ts:724
Protected
check Dynamic Pool Size
+
Defined in src/pools/abstract-pool.ts:174
Protected
create And Setup Dynamic Worker Node
+
Defined in src/pools/abstract-pool.ts:925
Protected
create And Setup Worker Node
+
Defined in src/pools/abstract-pool.ts:885
+
Defined in src/pools/cluster/fixed.ts:105
+
Defined in src/pools/abstract-pool.ts:687
Protected
destroy Worker Node
+
Defined in src/pools/cluster/fixed.ts:63
+
Defined in src/pools/abstract-pool.ts:572
+
Defined in src/pools/abstract-pool.ts:644
Protected
flush Tasks Queue
+
Defined in src/pools/abstract-pool.ts:1188
+
Defined in src/pools/abstract-pool.ts:1127
+
Defined in src/pools/abstract-pool.ts:623
+
Defined in src/pools/cluster/fixed.ts:58
Protected
register Worker Message Listener
+
Defined in src/pools/cluster/fixed.ts:97
Protected
send Startup Message To Worker
+
Defined in src/pools/cluster/fixed.ts:89
+
Defined in src/pools/cluster/fixed.ts:81
+
Defined in src/pools/abstract-pool.ts:584
+
Defined in src/pools/abstract-pool.ts:542
set Worker Choice Strategy Options
+
Defined in src/pools/abstract-pool.ts:561
+
Defined in src/pools/cluster/fixed.ts:53
+
Defined in src/pools/abstract-pool.ts:1059
@@ -45,7 +45,7 @@
+
Defined in src/pools/thread/fixed.ts:35
+
Defined in src/pools/thread/fixed.ts:46
Protected
Readonly
file Path
file Path : string
@@ -169,7 +169,7 @@
+
Defined in src/pools/abstract-pool.ts:105
Protected
Readonly
number Of Workers
number Of Workers : number
@@ -178,7 +178,7 @@
+
Defined in src/pools/abstract-pool.ts:104
Protected
Readonly
opts
@@ -187,7 +187,7 @@
+
Defined in src/pools/thread/fixed.ts:49
Protected
promise Response Map
@@ -201,7 +201,7 @@
+
Defined in src/pools/abstract-pool.ts:75
Protected
worker Choice Strategy Context
@@ -210,7 +210,7 @@
+
Defined in src/pools/abstract-pool.ts:81
Readonly
worker Nodes
@@ -219,7 +219,7 @@
+
Defined in src/pools/abstract-pool.ts:62
+
Defined in src/pools/abstract-pool.ts:607
+
Defined in src/pools/abstract-pool.ts:302
+
Defined in src/pools/thread/fixed.ts:137
+
Defined in src/pools/thread/fixed.ts:132
+
Defined in src/pools/abstract-pool.ts:445
+
Defined in src/pools/thread/fixed.ts:122
+
Defined in src/pools/abstract-pool.ts:462
+
Defined in src/pools/thread/fixed.ts:127
Protected
after Worker Node Setup
+
Defined in src/pools/abstract-pool.ts:976
Protected
before Task Execution Hook
+
Defined in src/pools/abstract-pool.ts:724
Protected
check Dynamic Pool Size
+
Defined in src/pools/abstract-pool.ts:174
Protected
create And Setup Dynamic Worker Node
+
Defined in src/pools/abstract-pool.ts:925
Protected
create And Setup Worker Node
+
Defined in src/pools/abstract-pool.ts:885
+
Defined in src/pools/thread/fixed.ts:114
+
Defined in src/pools/abstract-pool.ts:687
Protected
destroy Worker Node
+
Defined in src/pools/thread/fixed.ts:60
+
Defined in src/pools/abstract-pool.ts:572
+
Defined in src/pools/abstract-pool.ts:644
Protected
flush Tasks Queue
+
Defined in src/pools/abstract-pool.ts:1188
+
Defined in src/pools/abstract-pool.ts:1127
+
Defined in src/pools/abstract-pool.ts:623
+
Defined in src/pools/thread/fixed.ts:55
Protected
register Worker Message Listener
+
Defined in src/pools/thread/fixed.ts:104
Protected
send Startup Message To Worker
+
Defined in src/pools/thread/fixed.ts:88
+
Defined in src/pools/thread/fixed.ts:77
+
Defined in src/pools/abstract-pool.ts:584
+
Defined in src/pools/abstract-pool.ts:542
set Worker Choice Strategy Options
+
Defined in src/pools/abstract-pool.ts:561
+
Defined in src/pools/abstract-pool.ts:708
+
Defined in src/pools/abstract-pool.ts:1059
@@ -26,7 +26,7 @@
+
Defined in src/pools/pool.ts:39
+
Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/events.d.ts:109
+
Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/events.d.ts:390
Static
capture Rejections
capture Rejections : boolean
@@ -108,7 +109,7 @@
+Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/events.d.ts:397
Static
default Max Listeners
default Max Listeners : number
@@ -139,7 +140,7 @@ Its name
property is set to 'MaxListenersExceededWarning&
+Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/events.d.ts:434
Static
Readonly
error Monitor
@@ -152,7 +153,7 @@ regular 'error'
listener is installed.
+Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/events.d.ts:383
Methods
@@ -186,7 +187,7 @@ regular 'error'
listener is installed.
+Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/events.d.ts:454
+Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/events.d.ts:716
+Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/events.d.ts:779
+Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/events.d.ts:631
+Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/events.d.ts:725
+Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/events.d.ts:644
+Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/events.d.ts:604
+Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/events.d.ts:486
+Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/events.d.ts:516
+Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/events.d.ts:743
+Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/events.d.ts:759
+Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/events.d.ts:675
+Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/events.d.ts:615
+Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/events.d.ts:599
+Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/events.d.ts:625
+
+Static
add Abort Listener
+
+Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/events.d.ts:296
+Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/events.d.ts:325
+Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/events.d.ts:268
+Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/events.d.ts:250
Static
once
once ( emitter , eventName , options ? ) : Promise < any [] >
@@ -799,7 +844,7 @@ special handling:
Returns Promise < any [] >
+
Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/events.d.ts:190
Static
set Max Listeners
@@ -824,7 +869,7 @@ special handling:
+Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/events.d.ts:340
@@ -32,7 +32,7 @@
+
Defined in src/queue.ts:8
+
Defined in src/queue.ts:16
max Size
max Size : number
@@ -86,12 +86,12 @@
+
Defined in src/queue.ts:14
Private
offset
offset : number
+
Defined in src/queue.ts:10
size
size : number
@@ -99,7 +99,7 @@
+Defined in src/queue.ts:12
clear
@@ -126,7 +126,7 @@
Returns void
+Defined in src/queue.ts:68
+Defined in src/queue.ts:40
+Defined in src/queue.ts:26
+Defined in src/queue.ts:58
@@ -47,7 +47,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/thread-worker.ts:26
@@ -127,7 +127,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/thread-worker.ts:40
Protected
Readonly
is Main
is Main : boolean
@@ -147,7 +147,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:75
Protected
last Task Timestamp
last Task Timestamp : number
@@ -156,7 +156,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:55
Protected
Readonly
opts
@@ -165,7 +165,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:78
Private
port
port : MessagePort
@@ -173,7 +173,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/thread-worker.ts:33
Protected
statistics
@@ -182,7 +182,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:59
Protected
task Functions
@@ -191,7 +191,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:51
Accessors
@@ -205,7 +205,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/thread-worker.ts:75
Methods
@@ -240,7 +240,7 @@ If a task function with the same name already exists, it is replaced.
+Defined in src/worker/abstract-worker.ts:182
+Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/async_hooks.d.ts:306
+Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/async_hooks.d.ts:283
+Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/async_hooks.d.ts:302
+Defined in src/worker/abstract-worker.ts:365
+Defined in src/worker/thread-worker.ts:85
Protected
handle Kill Message
+Defined in src/worker/thread-worker.ts:68
Protected
handle Ready Message
+Defined in src/worker/thread-worker.ts:54
+Defined in src/worker/abstract-worker.ts:164
+Defined in src/worker/abstract-worker.ts:245
Protected
message Listener
+Defined in src/worker/abstract-worker.ts:295
+Defined in src/worker/abstract-worker.ts:221
+Defined in src/worker/abstract-worker.ts:397
+Defined in src/worker/abstract-worker.ts:451
+Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/async_hooks.d.ts:294
+Defined in src/worker/abstract-worker.ts:415
Protected
send To Main Worker
+Defined in src/worker/thread-worker.ts:80
+Defined in src/worker/abstract-worker.ts:258
+Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/async_hooks.d.ts:311
+Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/async_hooks.d.ts:277
@@ -42,7 +42,7 @@
WorkerChoiceStrategyContext
+
Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:27
+
Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:44
Private
worker Choice Strategy
worker Choice Strategy : "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN" = WorkerChoiceStrategies.ROUND_ROBIN
@@ -121,7 +121,7 @@
+
Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:46
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:167
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:113
get Task Statistics Requirements
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:126
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:185
set Options
@@ -200,7 +200,7 @@
Returns void
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:198
set Worker Choice Strategy
@@ -219,7 +219,7 @@
Returns void
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:139
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:153
@@ -26,7 +26,7 @@ Always returns a value greater than zero.
+
Defined in src/utils.ts:47
-
poolifier - v2.6.24
+
poolifier - v2.6.25
Index
@@ -105,7 +105,7 @@
Theme OS Light Dark
@@ -26,7 +26,7 @@
+
Defined in src/pools/cluster/fixed.ts:10
+
Defined in src/pools/pool.ts:148
Optional
enable Tasks Queue
enable Tasks Queue ?: boolean
@@ -70,7 +70,7 @@
+Defined in src/pools/pool.ts:154
+Defined in src/pools/cluster/fixed.ts:16
Optional
error Handler
@@ -89,7 +89,7 @@
+Defined in src/pools/pool.ts:120
Optional
exit Handler
@@ -98,7 +98,7 @@
+Defined in src/pools/pool.ts:128
Optional
message Handler
@@ -107,7 +107,7 @@
+Defined in src/pools/pool.ts:116
Optional
online Handler
@@ -116,7 +116,7 @@
+Defined in src/pools/pool.ts:124
Optional
restart Worker On Error
restart Worker On Error ?: boolean
@@ -125,7 +125,7 @@
+Defined in src/pools/pool.ts:142
+Defined in src/pools/cluster/fixed.ts:22
Optional
tasks Queue Options
@@ -144,7 +144,7 @@
+Defined in src/pools/pool.ts:158
Optional
worker Choice Strategy
worker Choice Strategy ?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
@@ -155,7 +155,7 @@
+Defined in src/pools/pool.ts:134
Optional
worker Choice Strategy Options
@@ -164,7 +164,7 @@
+Defined in src/pools/pool.ts:138
@@ -24,7 +24,7 @@
EventLoopUtilizationMeasurementStatistics
+
Defined in src/pools/worker.ts:71
+
Defined in src/pools/worker.ts:72
Optional
utilization
utilization ?: number
+
Defined in src/pools/worker.ts:74
@@ -46,7 +46,7 @@
+
Defined in src/pools/pool.ts:168
@@ -81,7 +81,7 @@
Returns Promise < void >
+
Defined in src/pools/pool.ts:209
Optional
Readonly
emitter
@@ -97,7 +97,7 @@
+Defined in src/pools/pool.ts:192
Readonly
enable Tasks Queue
enable Tasks Queue : ( ( enable , tasksQueueOptions ? ) => void )
@@ -126,7 +126,7 @@
Returns void
+Defined in src/pools/pool.ts:234
Readonly
execute
execute : ( ( data ? , name ? , transferList ? ) => Promise < Response > )
@@ -161,7 +161,7 @@
+Defined in src/pools/pool.ts:201
Readonly
info
@@ -169,7 +169,7 @@
+Defined in src/pools/pool.ts:176
Readonly
set Tasks Queue Options
set Tasks Queue Options : ( ( tasksQueueOptions ) => void )
@@ -193,7 +193,7 @@
Returns void
+Defined in src/pools/pool.ts:243
Readonly
set Worker Choice Strategy
set Worker Choice Strategy : ( ( workerChoiceStrategy , workerChoiceStrategyOptions ? ) => void )
@@ -222,7 +222,7 @@
Returns void
+Defined in src/pools/pool.ts:216
Readonly
set Worker Choice Strategy Options
set Worker Choice Strategy Options : ( ( workerChoiceStrategyOptions ) => void )
@@ -246,7 +246,7 @@
Returns void
+Defined in src/pools/pool.ts:225
Readonly
worker Nodes
@@ -254,7 +254,7 @@
+Defined in src/pools/pool.ts:180
@@ -24,7 +24,7 @@
+
Defined in src/pools/worker.ts:173
+
Defined in src/pools/worker.ts:177
Readonly
on
on : ( ( event , handler ) => void ) & ( ( event , handler ) => void ) & ( ( event , handler ) => void ) & ( ( event , handler ) => void )
@@ -118,7 +118,7 @@
Param The event handler.
+Defined in src/pools/worker.ts:185
Readonly
once
once : ( ( event , handler ) => void )
@@ -147,12 +147,12 @@
Returns void
+Defined in src/pools/worker.ts:195
Optional
Readonly
thread Id
thread Id ?: number
+Defined in src/pools/worker.ts:178
+
Defined in src/pools/selection-strategies/selection-strategies-types.ts:186
Readonly
remove
remove : ( ( workerNodeKey ) => boolean )
@@ -83,7 +83,7 @@
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:193
Readonly
reset
reset : ( ( ) => boolean )
@@ -100,7 +100,7 @@
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:174
Readonly
set Options
set Options : ( ( opts ) => void )
@@ -124,7 +124,7 @@
Returns void
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:199
Readonly
strategy Policy
@@ -132,7 +132,7 @@
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:164
Readonly
task Statistics Requirements
@@ -140,7 +140,7 @@
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:168
Readonly
update
update : ( ( workerNodeKey ) => boolean )
@@ -162,7 +162,7 @@
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:180
@@ -37,7 +37,7 @@
+
Defined in src/pools/worker.ts:205
@@ -73,7 +73,7 @@
Returns void
+
Defined in src/pools/worker.ts:240
Readonly
close Channel
close Channel : ( ( ) => void )
@@ -89,7 +89,7 @@
Returns void
+Defined in src/pools/worker.ts:248
Readonly
dequeue Task
dequeue Task : ( ( ) => undefined | Task < Data > )
@@ -106,7 +106,7 @@
+Defined in src/pools/worker.ts:236
Readonly
enqueue Task
enqueue Task : ( ( task ) => number )
@@ -131,7 +131,7 @@
+Defined in src/pools/worker.ts:230
Readonly
get Task Worker Usage
get Task Worker Usage : ( ( name ) => undefined | WorkerUsage )
@@ -152,7 +152,7 @@
+Defined in src/pools/worker.ts:252
Readonly
info
@@ -160,7 +160,7 @@
+Defined in src/pools/worker.ts:213
Readonly
reset Usage
reset Usage : ( ( ) => void )
@@ -176,7 +176,7 @@
Returns void
+Defined in src/pools/worker.ts:244
Readonly
tasks Queue Size
tasks Queue Size : ( ( ) => number )
@@ -193,7 +193,7 @@
+Defined in src/pools/worker.ts:223
usage
@@ -201,7 +201,7 @@
+Defined in src/pools/worker.ts:217
Readonly
worker
worker : Worker
@@ -209,7 +209,7 @@
+Defined in src/pools/worker.ts:209
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:65
@@ -24,7 +24,7 @@
+
Defined in src/pools/worker.ts:39
+
Defined in src/pools/worker.ts:43
Optional
average
average ?: number
@@ -56,7 +56,7 @@
+Defined in src/pools/worker.ts:55
Readonly
history
@@ -64,7 +64,7 @@
+Defined in src/pools/worker.ts:63
Optional
maximum
maximum ?: number
@@ -72,7 +72,7 @@
+Defined in src/pools/worker.ts:51
Optional
median
median ?: number
@@ -80,7 +80,7 @@
+Defined in src/pools/worker.ts:59
Optional
minimum
minimum ?: number
@@ -88,7 +88,7 @@
+Defined in src/pools/worker.ts:47
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:116
median
median : boolean
@@ -61,7 +61,7 @@
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:120
@@ -39,7 +39,7 @@
+
Defined in src/utility-types.ts:99
+
Defined in src/utility-types.ts:124
Optional
Readonly
data
data ?: Data
@@ -79,7 +79,7 @@
+
Defined in src/utility-types.ts:77
Optional
Readonly
kill
kill ?: true | "SOFT" | "HARD"
@@ -87,7 +87,7 @@
+Defined in src/utility-types.ts:104
Optional
Readonly
name
name ?: string
@@ -96,7 +96,7 @@
+Defined in src/utility-types.ts:73
Optional
Readonly
port
port ?: MessagePort
@@ -104,7 +104,7 @@
+Defined in src/utility-types.ts:128
Optional
Readonly
ready
ready ?: boolean
@@ -112,7 +112,7 @@
+Defined in src/utility-types.ts:120
Optional
Readonly
statistics
@@ -120,7 +120,7 @@
+Defined in src/utility-types.ts:116
Optional
Readonly
task Error
@@ -128,7 +128,7 @@
+Defined in src/utility-types.ts:108
Optional
Readonly
task Id
task Id ?: string
@@ -137,7 +137,7 @@
+Defined in src/utility-types.ts:89
Optional
Readonly
task Performance
@@ -145,7 +145,7 @@
+Defined in src/utility-types.ts:112
Optional
Readonly
timestamp
timestamp ?: number
@@ -154,7 +154,7 @@
+Defined in src/utility-types.ts:85
Optional
Readonly
transfer List
transfer List ?: TransferListItem []
@@ -163,7 +163,7 @@
+Defined in src/utility-types.ts:81
Readonly
worker Id
worker Id : number
@@ -172,7 +172,7 @@
+Defined in src/utility-types.ts:69
@@ -24,7 +24,7 @@
+
Defined in src/pools/pool.ts:60
+
Defined in src/pools/pool.ts:75
Readonly
executed Tasks
executed Tasks : number
+
Defined in src/pools/pool.ts:76
Readonly
executing Tasks
executing Tasks : number
+
Defined in src/pools/pool.ts:77
Readonly
failed Tasks
failed Tasks : number
+
Defined in src/pools/pool.ts:80
Readonly
idle Worker Nodes
idle Worker Nodes : number
@@ -83,32 +83,32 @@
+Defined in src/pools/pool.ts:73
Optional
Readonly
max Queued Tasks
max Queued Tasks ?: number
+Defined in src/pools/pool.ts:79
Readonly
max Size
max Size : number
+Defined in src/pools/pool.ts:67
Readonly
min Size
min Size : number
+Defined in src/pools/pool.ts:66
Optional
Readonly
queued Tasks
queued Tasks ?: number
+Defined in src/pools/pool.ts:78
Readonly
ready
ready : boolean
+Defined in src/pools/pool.ts:64
Optional
Readonly
run Time
run Time ?: {     average : number ;     maximum : number ;     median ?: number ;     minimum : number ; }
@@ -124,17 +124,17 @@
Readonly
minimum : number
+Defined in src/pools/pool.ts:81
Readonly
strategy
strategy : "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
+Defined in src/pools/pool.ts:65
Readonly
type
type : "fixed" | "dynamic"
+Defined in src/pools/pool.ts:62
Optional
Readonly
utilization
utilization ?: number
@@ -142,12 +142,12 @@
+Defined in src/pools/pool.ts:69
Readonly
version
version : string
+Defined in src/pools/pool.ts:61
Optional
Readonly
wait Time
wait Time ?: {     average : number ;     maximum : number ;     median ?: number ;     minimum : number ; }
@@ -163,12 +163,12 @@
Readonly
minimum : number
+Defined in src/pools/pool.ts:87
Readonly
worker
worker : "thread" | "cluster"
+Defined in src/pools/pool.ts:63
Readonly
worker Nodes
worker Nodes : number
@@ -176,7 +176,7 @@
+Defined in src/pools/pool.ts:71
@@ -35,7 +35,7 @@
ClusterPoolOptions
ThreadPoolOptions
+
Defined in src/pools/pool.ts:112
@@ -65,7 +65,7 @@
Default Value true
+
Defined in src/pools/pool.ts:148
Optional
enable Tasks Queue
enable Tasks Queue ?: boolean
@@ -75,7 +75,7 @@
Default Value false
+Defined in src/pools/pool.ts:154
Optional
error Handler
@@ -83,7 +83,7 @@
+Defined in src/pools/pool.ts:120
Optional
exit Handler
@@ -91,7 +91,7 @@
+Defined in src/pools/pool.ts:128
Optional
message Handler
@@ -99,7 +99,7 @@
+Defined in src/pools/pool.ts:116
Optional
online Handler
@@ -107,7 +107,7 @@
+Defined in src/pools/pool.ts:124
Optional
restart Worker On Error
restart Worker On Error ?: boolean
@@ -115,7 +115,7 @@
+Defined in src/pools/pool.ts:142
Optional
tasks Queue Options
@@ -123,7 +123,7 @@
+Defined in src/pools/pool.ts:158
Optional
worker Choice Strategy
worker Choice Strategy ?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
@@ -133,7 +133,7 @@
Default Value WorkerChoiceStrategies.ROUND_ROBIN
+Defined in src/pools/pool.ts:134
Optional
worker Choice Strategy Options
@@ -141,7 +141,7 @@
+Defined in src/pools/pool.ts:138
@@ -32,7 +32,7 @@
+
Defined in src/utility-types.ts:137
@@ -66,7 +66,7 @@
Returns void
+
Defined in src/utility-types.ts:145
Readonly
resolve
resolve : ( ( value ) => void )
@@ -87,7 +87,7 @@
Returns void
+Defined in src/utility-types.ts:141
Readonly
worker Node Key
worker Node Key : number
@@ -95,7 +95,7 @@
+Defined in src/utility-types.ts:149
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:152
@@ -34,7 +34,7 @@
+
Defined in src/utility-types.ts:65
+
Defined in src/utility-types.ts:77
Optional
Readonly
name
name ?: string
@@ -66,7 +66,7 @@
+Defined in src/utility-types.ts:73
Optional
Readonly
task Id
task Id ?: string
@@ -74,7 +74,7 @@
+Defined in src/utility-types.ts:89
Optional
Readonly
timestamp
timestamp ?: number
@@ -82,7 +82,7 @@
+Defined in src/utility-types.ts:85
Optional
Readonly
transfer List
transfer List ?: TransferListItem []
@@ -90,7 +90,7 @@
+Defined in src/utility-types.ts:81
Readonly
worker Id
worker Id : number
@@ -98,7 +98,7 @@
+Defined in src/utility-types.ts:69
@@ -32,7 +32,7 @@
+
Defined in src/utility-types.ts:10
+
Defined in src/utility-types.ts:22
Readonly
message
message : string
@@ -61,7 +61,7 @@
+Defined in src/utility-types.ts:18
Readonly
name
name : string
@@ -69,7 +69,7 @@
+Defined in src/utility-types.ts:14
@@ -24,7 +24,7 @@
+
Defined in src/utility-types.ts:30
+
Defined in src/utility-types.ts:46
Readonly
name
name : string
@@ -54,7 +54,7 @@
+Defined in src/utility-types.ts:34
Optional
Readonly
run Time
run Time ?: number
@@ -62,7 +62,7 @@
+Defined in src/utility-types.ts:42
Readonly
timestamp
timestamp : number
@@ -70,7 +70,7 @@
+Defined in src/utility-types.ts:38
@@ -24,7 +24,7 @@
+
Defined in src/pools/worker.ts:82
+
Defined in src/pools/worker.ts:86
executing
executing : number
@@ -55,7 +55,7 @@
+Defined in src/pools/worker.ts:90
failed
failed : number
@@ -63,7 +63,7 @@
+Defined in src/pools/worker.ts:102
Optional
Readonly
max Queued
max Queued ?: number
@@ -71,7 +71,7 @@
+Defined in src/pools/worker.ts:98
Readonly
queued
queued : number
@@ -79,7 +79,7 @@
+Defined in src/pools/worker.ts:94
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:132
Readonly
wait Time
@@ -61,7 +61,7 @@
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:136
@@ -24,7 +24,7 @@
+
Defined in src/pools/pool.ts:98
@@ -45,7 +45,7 @@
Default Value 1
+Defined in src/pools/pool.ts:104
@@ -26,7 +26,7 @@
+
Defined in src/pools/thread/fixed.ts:18
+
Defined in src/pools/pool.ts:148
Optional
enable Tasks Queue
enable Tasks Queue ?: boolean
@@ -69,7 +69,7 @@
+Defined in src/pools/pool.ts:154
Optional
error Handler
@@ -78,7 +78,7 @@
+Defined in src/pools/pool.ts:120
Optional
exit Handler
@@ -87,7 +87,7 @@
+Defined in src/pools/pool.ts:128
Optional
message Handler
@@ -96,7 +96,7 @@
+Defined in src/pools/pool.ts:116
Optional
online Handler
@@ -105,7 +105,7 @@
+Defined in src/pools/pool.ts:124
Optional
restart Worker On Error
restart Worker On Error ?: boolean
@@ -114,7 +114,7 @@
+Defined in src/pools/pool.ts:142
Optional
tasks Queue Options
@@ -123,7 +123,7 @@
+Defined in src/pools/pool.ts:158
Optional
worker Choice Strategy
worker Choice Strategy ?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
@@ -134,7 +134,7 @@
+Defined in src/pools/pool.ts:134
Optional
worker Choice Strategy Options
@@ -143,7 +143,7 @@
+Defined in src/pools/pool.ts:138
+Defined in src/pools/thread/fixed.ts:24
@@ -24,7 +24,7 @@
WorkerChoiceStrategyOptions
+
Defined in src/pools/selection-strategies/selection-strategies-types.ts:71
@@ -49,7 +49,7 @@
Default Value { median: false }
+
Defined in src/pools/selection-strategies/selection-strategies-types.ts:93
Optional
Readonly
measurement
measurement ?: "runTime" | "waitTime" | "elu"
@@ -57,7 +57,7 @@
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:75
Optional
Readonly
run Time
@@ -67,7 +67,7 @@
Default Value { median: false }
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:81
Optional
Readonly
wait Time
@@ -77,7 +77,7 @@
Default Value { median: false }
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:87
Optional
Readonly
weights
weights ?: Record < number , number >
@@ -88,7 +88,7 @@ Weight is the tasks maximum average or median runtime in milliseconds.
Default Value Computed worker weights automatically given the CPU performance.
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:100
@@ -24,7 +24,7 @@
+
Defined in src/pools/worker.ts:123
+
Defined in src/pools/worker.ts:135
Readonly
id
id : undefined | number
@@ -55,7 +55,7 @@
+Defined in src/pools/worker.ts:127
Optional
message Channel
message Channel ?: MessageChannel
@@ -63,7 +63,7 @@
+Defined in src/pools/worker.ts:143
ready
ready : boolean
@@ -71,7 +71,7 @@
+Defined in src/pools/worker.ts:139
type
type : "thread" | "cluster"
@@ -79,7 +79,7 @@
+Defined in src/pools/worker.ts:131
@@ -24,7 +24,7 @@
+
Defined in src/worker/worker-options.ts:23
@@ -49,7 +49,7 @@
Deprecated This option will be removed in the next major version.
+
Defined in src/worker/worker-options.ts:43
Optional
kill Behavior
kill Behavior ?: "SOFT" | "HARD"
@@ -64,7 +64,7 @@
Default Value KillBehaviors.SOFT
+Defined in src/worker/worker-options.ts:54
Optional
max Inactive Time
max Inactive Time ?: number
@@ -81,7 +81,7 @@ when this timeout expires your tasks is interrupted before completion and remove
Default Value 60000
+Defined in src/worker/worker-options.ts:36
@@ -24,7 +24,7 @@
+
Defined in src/pools/worker.ts:151
+
Defined in src/pools/worker.ts:167
Readonly
run Time
@@ -54,7 +54,7 @@
+Defined in src/pools/worker.ts:159
Readonly
tasks
@@ -62,7 +62,7 @@
+Defined in src/pools/worker.ts:155
Readonly
wait Time
@@ -70,7 +70,7 @@
+Defined in src/pools/worker.ts:163
@@ -40,7 +40,7 @@
Returns void
+Defined in src/pools/worker.ts:16
@@ -40,7 +40,7 @@
Returns void
+Defined in src/pools/worker.ts:29
+Defined in src/worker/worker-options.ts:18
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:56
@@ -40,7 +40,7 @@
Returns void
+Defined in src/pools/worker.ts:8
@@ -38,7 +38,7 @@
Returns void
+Defined in src/pools/worker.ts:24
+Defined in src/pools/pool.ts:55
+Defined in src/pools/pool.ts:34
@@ -47,7 +47,7 @@ This function must return a promise.
Returns Promise < Response >
+Defined in src/worker/task-functions.ts:18
@@ -34,7 +34,7 @@ This function can be synchronous or asynchronous.
+
Defined in src/worker/task-functions.ts:29
@@ -36,7 +36,7 @@ The value is the function itself.
+
Defined in src/worker/task-functions.ts:42
@@ -46,7 +46,7 @@
Returns Response
+Defined in src/worker/task-functions.ts:7
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:42
+Defined in src/pools/worker.ts:116
+Defined in src/worker/worker-options.ts:4
@@ -29,7 +29,7 @@
Readonly
wait Time : "waitTime"
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:47
@@ -33,7 +33,7 @@
Readonly
task Error : "taskError"
+Defined in src/pools/pool.ts:44
+Defined in src/pools/pool.ts:20
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:4
@@ -27,7 +27,7 @@
Readonly
thread : "thread"
+Defined in src/pools/worker.ts:108
Listens once to the
+abort
event on the providedsignal
.Listening to the
+abort
event on abort signals is unsafe and may +lead to resource leaks since another third party with the signal can +calle.stopImmediatePropagation()
. Unfortunately Node.js cannot change +this since it would violate the web standard. Additionally, the original +API makes it easy to forget to remove listeners.This API allows safely using
+AbortSignal
s in Node.js APIs by solving these +two issues by listening to the event such thatstopImmediatePropagation
does +not prevent the listener from running.Returns a disposable so that it may be unsubscribed from more easily.
+ +