From: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Date: Sun, 13 Aug 2023 20:46:57 +0000 (+0000) Subject: chore: generate documentation X-Git-Tag: v2.6.26~42^2~1^2 X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=1d9f69fa27366fd18f2600beeee89187306df22a;p=poolifier.git chore: generate documentation --- 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
  • Preparing search index...
    • -
  • The search index is not available
poolifier - v2.6.24
+
  • The search index is not available
    • 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

    • Properties

    @@ -196,7 +196,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:65

    • Protected Readonly filePath

    filePath: string
    @@ -204,7 +204,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:105

    • Protected Readonly numberOfWorkers

    numberOfWorkers: number
    @@ -212,7 +212,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:104

    • Protected Readonly opts

    opts: PoolOptions<Worker>
    @@ -220,7 +220,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:106

    • Protected promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
    @@ -233,7 +233,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:75

    • Private Readonly startTimestamp

    startTimestamp: 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 workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -257,7 +257,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:81

    • Readonly workerNodes

    workerNodes: IWorkerNode<Worker, Data>[] = []
    @@ -266,7 +266,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:62

    • Accessors

    @@ -280,7 +280,7 @@

    Returns boolean

    +
  • Defined in src/pools/abstract-pool.ts:616

    • Protected full

    +
  • Defined in src/pools/abstract-pool.ts:607

    • info

    +
  • Defined in src/pools/abstract-pool.ts:302

    • Protected Abstract maxSize

    +
  • Defined in src/pools/abstract-pool.ts:498

    • Protected Abstract minSize

    +
  • Defined in src/pools/abstract-pool.ts:493

    • Private ready

    +
  • Defined in src/pools/abstract-pool.ts:445

    • Protected Abstract type

    +
  • Defined in src/pools/abstract-pool.ts:483

    • Private utilization

    +
  • Defined in src/pools/abstract-pool.ts:462

    • Protected Abstract worker

    +
  • Defined in src/pools/abstract-pool.ts:488

    • Methods

    @@ -396,7 +396,7 @@

    Throws

    https://nodejs.org/api/errors.html#class-error If the added worker node is not found.

    +
  • Defined in src/pools/abstract-pool.ts:1138

    • Protected afterTaskExecutionHook

    +
  • Defined in src/pools/abstract-pool.ts:745

    • Protected afterWorkerNodeSetup

    +
  • Defined in src/pools/abstract-pool.ts:976

    • Protected beforeTaskExecutionHook

    +
  • Defined in src/pools/abstract-pool.ts:724

    • Private buildTasksQueueOptions

    Returns TasksQueueOptions

    +
  • Defined in src/pools/abstract-pool.ts:594

    • Private checkAndEmitEvents

    +
  • Defined in src/pools/abstract-pool.ts:1110

    • Protected checkDynamicPoolSize

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:174

    • Private checkFilePath

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:143

    • Private checkMessageWorkerId

    +
  • Defined in src/pools/abstract-pool.ts:506

    • Private checkNumberOfWorkers

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:156

    • Private checkPoolOptions

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:200

    • Private checkValidTasksQueueOptions

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:265

    • Private checkValidWorkerChoiceStrategy

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:227

    • Private checkValidWorkerChoiceStrategyOptions

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:237

    • Private chooseWorkerNode

    +
  • Defined in src/pools/abstract-pool.ts:839

    • Protected createAndSetupDynamicWorkerNode

    +
  • Defined in src/pools/abstract-pool.ts:925

    • Protected createAndSetupWorkerNode

    +
  • Defined in src/pools/abstract-pool.ts:885

    • Protected Abstract createWorker

    +
  • Defined in src/pools/abstract-pool.ts:878

    • Private dequeueTask

    Returns undefined | Task<Data>

    +
  • Defined in src/pools/abstract-pool.ts:1180

    • destroy

    +
  • Defined in src/pools/abstract-pool.ts:687

    • Protected Abstract destroyWorkerNode

    +
  • Defined in src/pools/abstract-pool.ts:700

    • enableTasksQueue

    +
  • Defined in src/pools/abstract-pool.ts:572

    • Private enqueueTask

    Returns number

    +
  • Defined in src/pools/abstract-pool.ts:1176

    • execute

    +
  • Defined in src/pools/abstract-pool.ts:644

    • Private executeTask

    +
  • Defined in src/pools/abstract-pool.ts:1171

    • Protected flushTasksQueue

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1188

    • Private flushTasksQueues

    +
  • Defined in src/pools/abstract-pool.ts:1198

    • Protected getWorkerInfo

    +
  • Defined in src/pools/abstract-pool.ts:1127

    • Private getWorkerNodeKeyByWorker

    +
  • Defined in src/pools/abstract-pool.ts:523

    • Private getWorkerNodeKeyByWorkerId

    +
  • Defined in src/pools/abstract-pool.ts:535

    • Private handleTaskExecutionResponse

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1081

    • Private handleWorkerReadyResponse

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1072

    • Protected internalBusy

    +
  • Defined in src/pools/abstract-pool.ts:623

    • Protected Abstract isMain

    +
  • Defined in src/pools/abstract-pool.ts:715

    • Private redistributeQueuedTasks

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1010

    • Protected Abstract registerWorkerMessageListener

    +
  • Defined in src/pools/abstract-pool.ts:963

    • Private removeWorkerNode

    +
  • Defined in src/pools/abstract-pool.ts:1157

    • Protected Abstract sendStartupMessageToWorker

    +
  • Defined in src/pools/abstract-pool.ts:990

    • Protected Abstract sendToWorker

    +
  • Defined in src/pools/abstract-pool.ts:867

    • Private sendWorkerStatisticsMessageToWorker

    +
  • Defined in src/pools/abstract-pool.ts:997

    • setTasksQueueOptions

    +
  • Defined in src/pools/abstract-pool.ts:584

    • setWorkerChoiceStrategy

    +
  • Defined in src/pools/abstract-pool.ts:542

    • setWorkerChoiceStrategyOptions

    +
  • Defined in src/pools/abstract-pool.ts:561

    • Protected setupHook

    +
  • Defined in src/pools/abstract-pool.ts:708

    • Private shallCreateDynamicWorker

    +
  • Defined in src/pools/abstract-pool.ts:856

    • Private startPool

    +
  • Defined in src/pools/abstract-pool.ts:289

    • Private tasksQueueSize

    Returns number

    +
  • Defined in src/pools/abstract-pool.ts:1184

    • Private updateEluWorkerUsage

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:800

    • Private updateRunTimeWorkerUsage

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:774

    • Private updateTaskStatisticsWorkerUsage

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:761

    • Private updateWaitTimeWorkerUsage

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:786

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:1059
    • @@ -1347,7 +1347,7 @@ Can be overridden.

  • updateWaitTimeWorkerUsage
  • workerListener
    • -
    @@ -47,7 +47,7 @@
  • ClusterWorker
  • ThreadWorker
    • +
  • Defined in src/worker/abstract-worker.ts:39
    • @@ -151,7 +151,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:73

    • Properties

    @@ -161,7 +161,7 @@
    +
  • 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 isMain

    isMain: boolean
    @@ -177,7 +177,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:75

    • Protected lastTaskTimestamp

    lastTaskTimestamp: number
    @@ -185,7 +185,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:55

    • Private Readonly mainWorker

    mainWorker: MainWorker
    @@ -193,7 +193,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:76

    • Protected Readonly opts

    opts: WorkerOptions = ...
    @@ -201,7 +201,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:78

    • Protected statistics

    statistics: WorkerStatistics
    @@ -209,7 +209,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:59

    • Protected taskFunctions

    taskFunctions: Map<string, TaskFunction<Data, Response>>
    @@ -217,7 +217,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:51

    • Methods

    @@ -251,7 +251,7 @@ If a task function with the same name already exists, it is replaced.

    Throws

    https://nodejs.org/api/errors.html#class-typeerror If the fn parameter is not a function.

    +
  • Defined in src/worker/abstract-worker.ts:182

    • asyncId

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/async_hooks.d.ts:306

    • Private beginTaskPerformance

    Returns TaskPerformance

    +
  • Defined in src/worker/abstract-worker.ts:501

    • bind

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/async_hooks.d.ts:283

    • Private checkActive

    +
  • Defined in src/worker/abstract-worker.ts:351

    • Private checkStatistics

    +
  • Defined in src/worker/abstract-worker.ts:525

    • Private checkTaskFunctions

    +
  • Defined in src/worker/abstract-worker.ts:110

    • Private checkWorkerOptions

    Returns void

    +
  • Defined in src/worker/abstract-worker.ts:98

    • emitDestroy

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/async_hooks.d.ts:302

    • Private endTaskPerformance

    Returns TaskPerformance

    +
  • Defined in src/worker/abstract-worker.ts:510

    • Protected getMainWorker

    +
  • Defined in src/worker/abstract-worker.ts:365

    • Private getTaskFunction

    +
  • Defined in src/worker/abstract-worker.ts:492

    • Protected handleError

    +
  • Defined in src/worker/abstract-worker.ts:387

    • Protected handleKillMessage

    +
  • Defined in src/worker/abstract-worker.ts:322

    • Protected Abstract handleReadyMessage

    +
  • Defined in src/worker/abstract-worker.ts:288

    • hasTaskFunction

    +
  • Defined in src/worker/abstract-worker.ts:164

    • listTaskFunctions

    +
  • Defined in src/worker/abstract-worker.ts:245

    • Protected messageListener

    +
  • Defined in src/worker/abstract-worker.ts:295

    • removeTaskFunction

    +
  • Defined in src/worker/abstract-worker.ts:221

    • Protected run

    +
  • Defined in src/worker/abstract-worker.ts:397

    • Protected runAsync

    +
  • Defined in src/worker/abstract-worker.ts:451

    • runInAsyncScope

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/async_hooks.d.ts:294

    • Protected runSync

    +
  • Defined in src/worker/abstract-worker.ts:415

    • Protected Abstract sendToMainWorker

    +
  • Defined in src/worker/abstract-worker.ts:377

    • setDefaultTaskFunction

    +
  • Defined in src/worker/abstract-worker.ts:258

    • Private startCheckActive

    +
  • Defined in src/worker/abstract-worker.ts:330

    • Private stopCheckActive

    +
  • Defined in src/worker/abstract-worker.ts:341

    • triggerAsyncId

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/async_hooks.d.ts:311

    • Private updateLastTaskTimestamp

    +
  • Defined in src/worker/abstract-worker.ts:531

    • Static bind

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/async_hooks.d.ts:277
    • @@ -859,7 +859,7 @@ then restore the original execution context.

  • updateLastTaskTimestamp
  • bind
    • -
    @@ -31,7 +31,7 @@ +
  • Defined in src/circular-array.ts:8
    • @@ -113,7 +113,7 @@

    Returns CircularArray<T>

    +
  • 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

    Returns void

    +
  • Defined in src/circular-array.ts:98

    • concat

    +
  • Defined in src/circular-array.ts:39

    • copyWithin

    +
  • Defined in src/circular-array.ts:90

    • entries

    +
  • Defined in src/circular-array.ts:94

    • includes

    +
  • Defined in src/circular-array.ts:21

    • reduce

    Returns void

    +
  • Defined in src/circular-array.ts:78

    • reverse

    +
  • Defined in src/circular-array.ts:54

    • toLocaleString

    +
  • Defined in src/circular-array.ts:30

    • values

    -
    @@ -47,7 +47,7 @@ but the minimum number of workers will be guaranteed.

    • ClusterWorker
    +
  • 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

    • Properties

    @@ -137,7 +137,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:63

    • Protected Readonly isMain

    isMain: boolean
    @@ -146,7 +146,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:75

    • Protected lastTaskTimestamp

    lastTaskTimestamp: 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

    opts: WorkerOptions = ...
    @@ -164,7 +164,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:78

    • Protected statistics

    statistics: WorkerStatistics
    @@ -173,7 +173,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:59

    • Protected taskFunctions

    taskFunctions: Map<string, TaskFunction<Data, Response>>
    @@ -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

    • asyncId

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/async_hooks.d.ts:306

    • bind

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/async_hooks.d.ts:283

    • emitDestroy

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/async_hooks.d.ts:302

    • Protected getMainWorker

    +
  • Defined in src/worker/abstract-worker.ts:365

    • Protected handleError

    +
  • Defined in src/worker/abstract-worker.ts:387

    • Protected handleKillMessage

    +
  • Defined in src/worker/abstract-worker.ts:322

    • Protected handleReadyMessage

    +
  • Defined in src/worker/cluster-worker.ts:45

    • hasTaskFunction

    +
  • Defined in src/worker/abstract-worker.ts:164

    • listTaskFunctions

    +
  • Defined in src/worker/abstract-worker.ts:245

    • Protected messageListener

    +
  • Defined in src/worker/abstract-worker.ts:295

    • removeTaskFunction

    +
  • Defined in src/worker/abstract-worker.ts:221

    • Protected run

    +
  • Defined in src/worker/abstract-worker.ts:397

    • Protected runAsync

    +
  • Defined in src/worker/abstract-worker.ts:451

    • runInAsyncScope

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/async_hooks.d.ts:294

    • Protected runSync

    +
  • Defined in src/worker/abstract-worker.ts:415

    • Protected sendToMainWorker

    +
  • Defined in src/worker/cluster-worker.ts:58

    • setDefaultTaskFunction

    +
  • Defined in src/worker/abstract-worker.ts:258

    • triggerAsyncId

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/async_hooks.d.ts:311

    • Static bind

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/async_hooks.d.ts:277
    • @@ -712,7 +712,7 @@ then restore the original execution context.

  • triggerAsyncId
  • bind
    • -
    @@ -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 filePath

    filePath: 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 numberOfWorkers

    numberOfWorkers: 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

    opts: ClusterPoolOptions = {}
    @@ -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 promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
    @@ -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 workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -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 workerNodes

    workerNodes: IWorkerNode<Worker, Data>[] = []
    @@ -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

    • Accessors

    @@ -248,7 +248,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/cluster/dynamic.ts:48

    • Protected full

    +
  • Defined in src/pools/abstract-pool.ts:607

    • info

    +
  • Defined in src/pools/abstract-pool.ts:302

    • Protected maxSize

    +
  • Defined in src/pools/cluster/dynamic.ts:43

    • Protected minSize

    +
  • Defined in src/pools/cluster/fixed.ts:120

    • Private ready

    +
  • Defined in src/pools/abstract-pool.ts:445

    • Protected type

    +
  • Defined in src/pools/cluster/dynamic.ts:38

    • Private utilization

    +
  • Defined in src/pools/abstract-pool.ts:462

    • Protected worker

    +
  • Defined in src/pools/cluster/fixed.ts:115

    • Methods

    @@ -375,7 +375,7 @@ Can be overridden.

    +
  • Defined in src/pools/abstract-pool.ts:745

    • Protected afterWorkerNodeSetup

    +
  • Defined in src/pools/abstract-pool.ts:976

    • Protected beforeTaskExecutionHook

    +
  • Defined in src/pools/abstract-pool.ts:724

    • Protected checkDynamicPoolSize

    +
  • Defined in src/pools/abstract-pool.ts:174

    • Protected createAndSetupDynamicWorkerNode

    +
  • Defined in src/pools/abstract-pool.ts:925

    • Protected createAndSetupWorkerNode

    +
  • Defined in src/pools/abstract-pool.ts:885

    • Protected createWorker

    +
  • Defined in src/pools/cluster/fixed.ts:105

    • destroy

    +
  • Defined in src/pools/abstract-pool.ts:687

    • Protected destroyWorkerNode

    +
  • Defined in src/pools/cluster/fixed.ts:63

    • enableTasksQueue

    +
  • Defined in src/pools/abstract-pool.ts:572

    • execute

    +
  • Defined in src/pools/abstract-pool.ts:644

    • Protected flushTasksQueue

    +
  • Defined in src/pools/abstract-pool.ts:1188

    • Protected getWorkerInfo

    +
  • Defined in src/pools/abstract-pool.ts:1127

    • Protected internalBusy

    +
  • Defined in src/pools/abstract-pool.ts:623

    • Protected isMain

    +
  • Defined in src/pools/cluster/fixed.ts:58

    • Protected registerWorkerMessageListener

    +
  • Defined in src/pools/cluster/fixed.ts:97

    • Protected sendStartupMessageToWorker

    +
  • Defined in src/pools/cluster/fixed.ts:89

    • Protected sendToWorker

    +
  • Defined in src/pools/cluster/fixed.ts:81

    • setTasksQueueOptions

    +
  • Defined in src/pools/abstract-pool.ts:584

    • setWorkerChoiceStrategy

    +
  • Defined in src/pools/abstract-pool.ts:542

    • setWorkerChoiceStrategyOptions

    +
  • Defined in src/pools/abstract-pool.ts:561

    • Protected setupHook

    +
  • Defined in src/pools/cluster/fixed.ts:53

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:1059
    • @@ -879,7 +879,7 @@ Can be overridden.

  • setupHook
  • workerListener
    • -
    @@ -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 filePath

    filePath: 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 numberOfWorkers

    numberOfWorkers: 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

    opts: ThreadPoolOptions = {}
    @@ -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 promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
    @@ -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 workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -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 workerNodes

    workerNodes: IWorkerNode<Worker, Data>[] = []
    @@ -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

    • Protected full

    +
  • Defined in src/pools/abstract-pool.ts:607

    • info

    +
  • Defined in src/pools/abstract-pool.ts:302

    • Protected maxSize

    +
  • Defined in src/pools/thread/dynamic.ts:43

    • Protected minSize

    +
  • Defined in src/pools/thread/fixed.ts:132

    • Private ready

    +
  • Defined in src/pools/abstract-pool.ts:445

    • Protected type

    +
  • Defined in src/pools/thread/dynamic.ts:38

    • Private utilization

    +
  • Defined in src/pools/abstract-pool.ts:462

    • Protected worker

    +
  • Defined in src/pools/thread/fixed.ts:127

    • Methods

    @@ -375,7 +375,7 @@ Can be overridden.

    +
  • Defined in src/pools/abstract-pool.ts:745

    • Protected afterWorkerNodeSetup

    +
  • Defined in src/pools/abstract-pool.ts:976

    • Protected beforeTaskExecutionHook

    +
  • Defined in src/pools/abstract-pool.ts:724

    • Protected checkDynamicPoolSize

    +
  • Defined in src/pools/abstract-pool.ts:174

    • Protected createAndSetupDynamicWorkerNode

    +
  • Defined in src/pools/abstract-pool.ts:925

    • Protected createAndSetupWorkerNode

    +
  • Defined in src/pools/abstract-pool.ts:885

    • Protected createWorker

    +
  • Defined in src/pools/thread/fixed.ts:114

    • destroy

    +
  • Defined in src/pools/abstract-pool.ts:687

    • Protected destroyWorkerNode

    +
  • Defined in src/pools/thread/fixed.ts:60

    • enableTasksQueue

    +
  • Defined in src/pools/abstract-pool.ts:572

    • execute

    +
  • Defined in src/pools/abstract-pool.ts:644

    • Protected flushTasksQueue

    +
  • Defined in src/pools/abstract-pool.ts:1188

    • Protected getWorkerInfo

    +
  • Defined in src/pools/abstract-pool.ts:1127

    • Protected internalBusy

    +
  • Defined in src/pools/abstract-pool.ts:623

    • Protected isMain

    +
  • Defined in src/pools/thread/fixed.ts:55

    • Protected registerWorkerMessageListener

    +
  • Defined in src/pools/thread/fixed.ts:104

    • Protected sendStartupMessageToWorker

    +
  • Defined in src/pools/thread/fixed.ts:88

    • Protected sendToWorker

    +
  • Defined in src/pools/thread/fixed.ts:77

    • setTasksQueueOptions

    +
  • Defined in src/pools/abstract-pool.ts:584

    • setWorkerChoiceStrategy

    +
  • Defined in src/pools/abstract-pool.ts:542

    • setWorkerChoiceStrategyOptions

    +
  • Defined in src/pools/abstract-pool.ts:561

    • Protected setupHook

    +
  • Defined in src/pools/abstract-pool.ts:708

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:1059
    • @@ -884,7 +884,7 @@ Can be overridden.

  • setupHook
  • workerListener
    • -
    @@ -45,7 +45,7 @@ +
  • Defined in src/pools/cluster/fixed.ts:33
    • @@ -141,7 +141,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:44

    • Properties

    @@ -160,7 +160,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:65

    • Protected Readonly filePath

    filePath: string
    @@ -169,7 +169,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:105

    • Protected Readonly numberOfWorkers

    numberOfWorkers: number
    @@ -178,7 +178,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:104

    • Protected Readonly opts

    opts: ClusterPoolOptions = {}
    @@ -187,7 +187,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:47

    • Protected promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
    @@ -201,7 +201,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:75

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -210,7 +210,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:81

    • Readonly workerNodes

    workerNodes: IWorkerNode<Worker, Data>[] = []
    @@ -219,7 +219,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:62

    • Accessors

    @@ -234,7 +234,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:130

    • Protected full

    +
  • Defined in src/pools/abstract-pool.ts:607

    • info

    +
  • Defined in src/pools/abstract-pool.ts:302

    • Protected maxSize

    +
  • Defined in src/pools/cluster/fixed.ts:125

    • Protected minSize

    +
  • Defined in src/pools/cluster/fixed.ts:120

    • Private ready

    +
  • Defined in src/pools/abstract-pool.ts:445

    • Protected type

    +
  • Defined in src/pools/cluster/fixed.ts:110

    • Private utilization

    +
  • Defined in src/pools/abstract-pool.ts:462

    • Protected worker

    +
  • Defined in src/pools/cluster/fixed.ts:115

    • Methods

    @@ -361,7 +361,7 @@ Can be overridden.

    +
  • Defined in src/pools/abstract-pool.ts:745

    • Protected afterWorkerNodeSetup

    +
  • Defined in src/pools/abstract-pool.ts:976

    • Protected beforeTaskExecutionHook

    +
  • Defined in src/pools/abstract-pool.ts:724

    • Protected checkDynamicPoolSize

    +
  • Defined in src/pools/abstract-pool.ts:174

    • Protected createAndSetupDynamicWorkerNode

    +
  • Defined in src/pools/abstract-pool.ts:925

    • Protected createAndSetupWorkerNode

    +
  • Defined in src/pools/abstract-pool.ts:885

    • Protected createWorker

    +
  • Defined in src/pools/cluster/fixed.ts:105

    • destroy

    +
  • Defined in src/pools/abstract-pool.ts:687

    • Protected destroyWorkerNode

    +
  • Defined in src/pools/cluster/fixed.ts:63

    • enableTasksQueue

    +
  • Defined in src/pools/abstract-pool.ts:572

    • execute

    +
  • Defined in src/pools/abstract-pool.ts:644

    • Protected flushTasksQueue

    +
  • Defined in src/pools/abstract-pool.ts:1188

    • Protected getWorkerInfo

    +
  • Defined in src/pools/abstract-pool.ts:1127

    • Protected internalBusy

    +
  • Defined in src/pools/abstract-pool.ts:623

    • Protected isMain

    +
  • Defined in src/pools/cluster/fixed.ts:58

    • Protected registerWorkerMessageListener

    +
  • Defined in src/pools/cluster/fixed.ts:97

    • Protected sendStartupMessageToWorker

    +
  • Defined in src/pools/cluster/fixed.ts:89

    • Protected sendToWorker

    +
  • Defined in src/pools/cluster/fixed.ts:81

    • setTasksQueueOptions

    +
  • Defined in src/pools/abstract-pool.ts:584

    • setWorkerChoiceStrategy

    +
  • Defined in src/pools/abstract-pool.ts:542

    • setWorkerChoiceStrategyOptions

    +
  • Defined in src/pools/abstract-pool.ts:561

    • Protected setupHook

    +
  • Defined in src/pools/cluster/fixed.ts:53

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:1059
    • @@ -864,7 +864,7 @@ Can be overridden.

  • setupHook
  • workerListener
    • -
    @@ -45,7 +45,7 @@ +
  • Defined in src/pools/thread/fixed.ts:35
    • @@ -141,7 +141,7 @@
    +
  • Defined in src/pools/thread/fixed.ts:46

    • Properties

    @@ -160,7 +160,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:65

    • Protected Readonly filePath

    filePath: string
    @@ -169,7 +169,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:105

    • Protected Readonly numberOfWorkers

    numberOfWorkers: number
    @@ -178,7 +178,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:104

    • Protected Readonly opts

    opts: ThreadPoolOptions = {}
    @@ -187,7 +187,7 @@
    +
  • Defined in src/pools/thread/fixed.ts:49

    • Protected promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
    @@ -201,7 +201,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:75

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -210,7 +210,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:81

    • Readonly workerNodes

    workerNodes: IWorkerNode<Worker, Data>[] = []
    @@ -219,7 +219,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:62

    • Accessors

    @@ -234,7 +234,7 @@
    +
  • Defined in src/pools/thread/fixed.ts:142

    • Protected full

    +
  • Defined in src/pools/abstract-pool.ts:607

    • info

    +
  • Defined in src/pools/abstract-pool.ts:302

    • Protected maxSize

    +
  • Defined in src/pools/thread/fixed.ts:137

    • Protected minSize

    +
  • Defined in src/pools/thread/fixed.ts:132

    • Private ready

    +
  • Defined in src/pools/abstract-pool.ts:445

    • Protected type

    +
  • Defined in src/pools/thread/fixed.ts:122

    • Private utilization

    +
  • Defined in src/pools/abstract-pool.ts:462

    • Protected worker

    +
  • Defined in src/pools/thread/fixed.ts:127

    • Methods

    @@ -361,7 +361,7 @@ Can be overridden.

    +
  • Defined in src/pools/abstract-pool.ts:745

    • Protected afterWorkerNodeSetup

    +
  • Defined in src/pools/abstract-pool.ts:976

    • Protected beforeTaskExecutionHook

    +
  • Defined in src/pools/abstract-pool.ts:724

    • Protected checkDynamicPoolSize

    +
  • Defined in src/pools/abstract-pool.ts:174

    • Protected createAndSetupDynamicWorkerNode

    +
  • Defined in src/pools/abstract-pool.ts:925

    • Protected createAndSetupWorkerNode

    +
  • Defined in src/pools/abstract-pool.ts:885

    • Protected createWorker

    +
  • Defined in src/pools/thread/fixed.ts:114

    • destroy

    +
  • Defined in src/pools/abstract-pool.ts:687

    • Protected destroyWorkerNode

    +
  • Defined in src/pools/thread/fixed.ts:60

    • enableTasksQueue

    +
  • Defined in src/pools/abstract-pool.ts:572

    • execute

    +
  • Defined in src/pools/abstract-pool.ts:644

    • Protected flushTasksQueue

    +
  • Defined in src/pools/abstract-pool.ts:1188

    • Protected getWorkerInfo

    +
  • Defined in src/pools/abstract-pool.ts:1127

    • Protected internalBusy

    +
  • Defined in src/pools/abstract-pool.ts:623

    • Protected isMain

    +
  • Defined in src/pools/thread/fixed.ts:55

    • Protected registerWorkerMessageListener

    +
  • Defined in src/pools/thread/fixed.ts:104

    • Protected sendStartupMessageToWorker

    +
  • Defined in src/pools/thread/fixed.ts:88

    • Protected sendToWorker

    +
  • Defined in src/pools/thread/fixed.ts:77

    • setTasksQueueOptions

    +
  • Defined in src/pools/abstract-pool.ts:584

    • setWorkerChoiceStrategy

    +
  • Defined in src/pools/abstract-pool.ts:542

    • setWorkerChoiceStrategyOptions

    +
  • Defined in src/pools/abstract-pool.ts:561

    • Protected setupHook

    +
  • Defined in src/pools/abstract-pool.ts:708

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:1059
    • @@ -869,7 +869,7 @@ Can be overridden.

  • setupHook
  • workerListener
    • -
    @@ -26,7 +26,7 @@ +
  • Defined in src/pools/pool.ts:39
    • @@ -60,6 +60,7 @@ removeAllListeners removeListener setMaxListeners +addAbortListener getEventListeners getMaxListeners listenerCount @@ -82,7 +83,7 @@

    Returns PoolEmitter

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/events.d.ts:109

    • Properties

    @@ -96,7 +97,7 @@
    +
  • Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/events.d.ts:390

    • Static captureRejections

    captureRejections: boolean
    @@ -108,7 +109,7 @@
    +
  • Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/events.d.ts:397

    • Static defaultMaxListeners

    defaultMaxListeners: 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 errorMonitor

    errorMonitor: typeof errorMonitor
    @@ -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

    • emit

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/events.d.ts:716

    • eventNames

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/events.d.ts:779

    • getMaxListeners

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/events.d.ts:631

    • listenerCount

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/events.d.ts:725

    • listeners

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/events.d.ts:644

    • off

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/events.d.ts:604

    • on

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/events.d.ts:486

    • once

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/events.d.ts:516

    • prependListener

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/events.d.ts:743

    • prependOnceListener

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/events.d.ts:759

    • rawListeners

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/events.d.ts:675

    • removeAllListeners

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/events.d.ts:615

    • removeListener

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/events.d.ts:599

    • setMaxListeners

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/events.d.ts:625
    • +
    +

    Static addAbortListener

    +

    Static getEventListeners

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/events.d.ts:296

    • Static getMaxListeners

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/events.d.ts:325

    • Static listenerCount

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/events.d.ts:268

    • Static on

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/events.d.ts:250

    • Static once

  • @@ -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 setMaxListeners

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/events.d.ts:340
    • @@ -864,6 +909,7 @@ special handling:

  • removeAllListeners
  • removeListener
  • setMaxListeners
    • +
  • addAbortListener
  • getEventListeners
  • getMaxListeners
  • listenerCount
    • @@ -871,7 +917,7 @@ special handling:

  • once
  • setMaxListeners
    • -
    @@ -32,7 +32,7 @@
    • Queue
    +
  • Defined in src/queue.ts:8
    • @@ -71,14 +71,14 @@

    T

    Returns Queue<T>

    +
  • Defined in src/queue.ts:16

    • Properties

    Private items

    items: T[]
    +
  • Defined in src/queue.ts:9

    • maxSize

    maxSize: 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

    • Methods

    @@ -115,7 +115,7 @@

    See

    https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols

    +
  • Defined in src/queue.ts:81

    • clear

    +
  • Defined in src/queue.ts:68

    • dequeue

    +
  • Defined in src/queue.ts:40

    • enqueue

    +
  • Defined in src/queue.ts:26

    • peek

    +
  • Defined in src/queue.ts:58
    • @@ -201,7 +201,7 @@
  • enqueue
  • peek
    • -
    @@ -47,7 +47,7 @@ but the minimum number of workers will be guaranteed.

    • ThreadWorker
    +
  • 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

    • Properties

    @@ -138,7 +138,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:63

    • Protected Readonly isMain

    isMain: boolean
    @@ -147,7 +147,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:75

    • Protected lastTaskTimestamp

    lastTaskTimestamp: 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

    opts: WorkerOptions = ...
    @@ -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

    statistics: WorkerStatistics
    @@ -182,7 +182,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:59

    • Protected taskFunctions

    taskFunctions: Map<string, TaskFunction<Data, Response>>
    @@ -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

    • asyncId

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/async_hooks.d.ts:306

    • bind

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/async_hooks.d.ts:283

    • emitDestroy

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/async_hooks.d.ts:302

    • Protected getMainWorker

    +
  • Defined in src/worker/abstract-worker.ts:365

    • Protected handleError

    +
  • Defined in src/worker/thread-worker.ts:85

    • Protected handleKillMessage

    +
  • Defined in src/worker/thread-worker.ts:68

    • Protected handleReadyMessage

    +
  • Defined in src/worker/thread-worker.ts:54

    • hasTaskFunction

    +
  • Defined in src/worker/abstract-worker.ts:164

    • listTaskFunctions

    +
  • Defined in src/worker/abstract-worker.ts:245

    • Protected messageListener

    +
  • Defined in src/worker/abstract-worker.ts:295

    • removeTaskFunction

    +
  • Defined in src/worker/abstract-worker.ts:221

    • Protected run

    +
  • Defined in src/worker/abstract-worker.ts:397

    • Protected runAsync

    +
  • Defined in src/worker/abstract-worker.ts:451

    • runInAsyncScope

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/async_hooks.d.ts:294

    • Protected runSync

    +
  • Defined in src/worker/abstract-worker.ts:415

    • Protected sendToMainWorker

    +
  • Defined in src/worker/thread-worker.ts:80

    • setDefaultTaskFunction

    +
  • Defined in src/worker/abstract-worker.ts:258

    • triggerAsyncId

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/async_hooks.d.ts:311

    • Static bind

    +
  • Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/async_hooks.d.ts:277
    • @@ -722,7 +722,7 @@ then restore the original execution context.

  • triggerAsyncId
  • bind
    • -
    @@ -42,7 +42,7 @@
    • WorkerChoiceStrategyContext
    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:27
    • @@ -106,14 +106,14 @@

    Returns WorkerChoiceStrategyContext<Worker, Data, Response>

    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:44

    • Properties

    Private Readonly workerChoiceStrategies

    workerChoiceStrategies: Map<"ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN", IWorkerChoiceStrategy>
    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:32

    • Private workerChoiceStrategy

    workerChoiceStrategy: "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

    • Methods

    @@ -137,7 +137,7 @@

    Throws

    https://nodejs.org/api/errors.html#class-error If the worker node key is null or undefined.

    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:167

    • getStrategyPolicy

    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:113

    • getTaskStatisticsRequirements

    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:126

    • remove

    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:185

    • setOptions

    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:198

    • setWorkerChoiceStrategy

    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:139

    • update

    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:153
    • @@ -267,7 +267,7 @@
  • setWorkerChoiceStrategy
  • update
    • -
    @@ -26,7 +26,7 @@ Always returns a value greater than zero.

    +
  • Defined in src/utils.ts:47
    • @@ -43,7 +43,7 @@ Always returns a value greater than zero.

    Theme

    -
    -

    poolifier - v2.6.24

    +

    poolifier - v2.6.25

    Index

    @@ -105,7 +105,7 @@

    Theme

    -
    @@ -26,7 +26,7 @@
    • ClusterPoolOptions
    +
  • Defined in src/pools/cluster/fixed.ts:10
    • @@ -59,7 +59,7 @@
    +
  • Defined in src/pools/pool.ts:148

    • Optional enableTasksQueue

    enableTasksQueue?: boolean
    @@ -70,7 +70,7 @@
    +
  • Defined in src/pools/pool.ts:154

    • Optional env

    env?: Record<string, unknown>
    @@ -80,7 +80,7 @@

    See

    https://nodejs.org/api/cluster.html#cluster_cluster_fork_env

    +
  • Defined in src/pools/cluster/fixed.ts:16

    • Optional errorHandler

    errorHandler?: ErrorHandler<Worker>
    @@ -89,7 +89,7 @@
    +
  • Defined in src/pools/pool.ts:120

    • Optional exitHandler

    exitHandler?: ExitHandler<Worker>
    @@ -98,7 +98,7 @@
    +
  • Defined in src/pools/pool.ts:128

    • Optional messageHandler

    messageHandler?: MessageHandler<Worker>
    @@ -107,7 +107,7 @@
    +
  • Defined in src/pools/pool.ts:116

    • Optional onlineHandler

    onlineHandler?: OnlineHandler<Worker>
    @@ -116,7 +116,7 @@
    +
  • Defined in src/pools/pool.ts:124

    • Optional restartWorkerOnError

    restartWorkerOnError?: boolean
    @@ -125,7 +125,7 @@
    +
  • Defined in src/pools/pool.ts:142

    • Optional settings

    settings?: ClusterSettings
    @@ -135,7 +135,7 @@

    See

    https://nodejs.org/api/cluster.html#cluster_cluster_settings

    +
  • Defined in src/pools/cluster/fixed.ts:22

    • Optional tasksQueueOptions

    tasksQueueOptions?: TasksQueueOptions
    @@ -144,7 +144,7 @@
    +
  • Defined in src/pools/pool.ts:158

    • Optional workerChoiceStrategy

    workerChoiceStrategy?: "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 workerChoiceStrategyOptions

    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    @@ -164,7 +164,7 @@
    +
  • Defined in src/pools/pool.ts:138
    • @@ -197,7 +197,7 @@
  • workerChoiceStrategy
  • workerChoiceStrategyOptions
    • -
    @@ -24,7 +24,7 @@
    • EventLoopUtilizationMeasurementStatistics
    +
  • Defined in src/pools/worker.ts:71
    • @@ -42,17 +42,17 @@

    Readonly active

    active: MeasurementStatistics
    +
  • Defined in src/pools/worker.ts:73

    • Readonly idle

    idle: MeasurementStatistics
    +
  • Defined in src/pools/worker.ts:72

    • Optional utilization

    utilization?: number
    +
  • Defined in src/pools/worker.ts:74
    • @@ -76,7 +76,7 @@
  • idle
  • utilization
    • -
    @@ -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

    emitter?: PoolEmitter
    @@ -97,7 +97,7 @@
    +
  • Defined in src/pools/pool.ts:192

    • Readonly enableTasksQueue

    enableTasksQueue: ((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

    info: PoolInfo
    @@ -169,7 +169,7 @@
    +
  • Defined in src/pools/pool.ts:176

    • Readonly setTasksQueueOptions

    setTasksQueueOptions: ((tasksQueueOptions) => void)
    @@ -193,7 +193,7 @@

    Returns void

    +
  • Defined in src/pools/pool.ts:243

    • Readonly setWorkerChoiceStrategy

    setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void)
    @@ -222,7 +222,7 @@

    Returns void

    +
  • Defined in src/pools/pool.ts:216

    • Readonly setWorkerChoiceStrategyOptions

    setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)
    @@ -246,7 +246,7 @@

    Returns void

    +
  • Defined in src/pools/pool.ts:225

    • Readonly workerNodes

    workerNodes: IWorkerNode<Worker, Data>[]
    @@ -254,7 +254,7 @@
    +
  • Defined in src/pools/pool.ts:180
    • @@ -284,7 +284,7 @@
  • setWorkerChoiceStrategyOptions
  • workerNodes
    • -
    @@ -24,7 +24,7 @@
    • IWorker
    +
  • Defined in src/pools/worker.ts:173
    • @@ -46,7 +46,7 @@
    +
  • 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 threadId

    threadId?: number
    +
  • Defined in src/pools/worker.ts:178
    • @@ -177,7 +177,7 @@
  • once
  • threadId
    • -
    @@ -24,7 +24,7 @@
    • IWorkerChoiceStrategy
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:160
    • @@ -58,7 +58,7 @@
    +
  • 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 setOptions

    setOptions: ((opts) => void)
    @@ -124,7 +124,7 @@

    Returns void

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:199

    • Readonly strategyPolicy

    strategyPolicy: StrategyPolicy
    @@ -132,7 +132,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:164

    • Readonly taskStatisticsRequirements

    taskStatisticsRequirements: TaskStatisticsRequirements
    @@ -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
    • @@ -190,7 +190,7 @@
  • taskStatisticsRequirements
  • update
    • -
    @@ -37,7 +37,7 @@
    • IWorkerNode
    +
  • Defined in src/pools/worker.ts:205
    • @@ -73,7 +73,7 @@

    Returns void

    +
  • Defined in src/pools/worker.ts:240

    • Readonly closeChannel

    closeChannel: (() => void)
    @@ -89,7 +89,7 @@

    Returns void

    +
  • Defined in src/pools/worker.ts:248

    • Readonly dequeueTask

    dequeueTask: (() => undefined | Task<Data>)
    @@ -106,7 +106,7 @@
    +
  • Defined in src/pools/worker.ts:236

    • Readonly enqueueTask

    enqueueTask: ((task) => number)
    @@ -131,7 +131,7 @@
    +
  • Defined in src/pools/worker.ts:230

    • Readonly getTaskWorkerUsage

    getTaskWorkerUsage: ((name) => undefined | WorkerUsage)
    @@ -152,7 +152,7 @@

    Returns undefined | WorkerUsage

    +
  • Defined in src/pools/worker.ts:252

    • Readonly info

    info: WorkerInfo
    @@ -160,7 +160,7 @@
    +
  • Defined in src/pools/worker.ts:213

    • Readonly resetUsage

    resetUsage: (() => void)
    @@ -176,7 +176,7 @@

    Returns void

    +
  • Defined in src/pools/worker.ts:244

    • Readonly tasksQueueSize

    tasksQueueSize: (() => number)
    @@ -193,7 +193,7 @@
    +
  • Defined in src/pools/worker.ts:223

    • usage

    usage: WorkerUsage
    @@ -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
    • @@ -240,7 +240,7 @@
  • usage
  • worker
    • -
    @@ -24,7 +24,7 @@
    • MeasurementOptions
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:61
    • @@ -43,7 +43,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:65
    • @@ -65,7 +65,7 @@
    -
    @@ -24,7 +24,7 @@
    • MeasurementStatistics
    +
  • Defined in src/pools/worker.ts:39
    • @@ -48,7 +48,7 @@
    +
  • Defined in src/pools/worker.ts:43

    • Optional average

    average?: number
    @@ -56,7 +56,7 @@
    +
  • Defined in src/pools/worker.ts:55

    • Readonly history

    history: CircularArray<number>
    @@ -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
    • @@ -115,7 +115,7 @@
  • median
  • minimum
    • -
    @@ -24,7 +24,7 @@
    • MeasurementStatisticsRequirements
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:108
    • @@ -45,7 +45,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:112

    • average

    average: boolean
    @@ -53,7 +53,7 @@
    +
  • 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
    • @@ -85,7 +85,7 @@
  • average
  • median
    • -
    @@ -39,7 +39,7 @@
    • MessageValue
    +
  • Defined in src/utility-types.ts:99
    • @@ -70,7 +70,7 @@
    +
  • 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

    statistics?: WorkerStatistics
    @@ -120,7 +120,7 @@
    +
  • Defined in src/utility-types.ts:116

    • Optional Readonly taskError

    taskError?: TaskError<ErrorData>
    @@ -128,7 +128,7 @@
    +
  • Defined in src/utility-types.ts:108

    • Optional Readonly taskId

    taskId?: string
    @@ -137,7 +137,7 @@
    +
  • Defined in src/utility-types.ts:89

    • Optional Readonly taskPerformance

    taskPerformance?: TaskPerformance
    @@ -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 transferList

    transferList?: TransferListItem[]
    @@ -163,7 +163,7 @@
    +
  • Defined in src/utility-types.ts:81

    • Readonly workerId

    workerId: number
    @@ -172,7 +172,7 @@
    +
  • Defined in src/utility-types.ts:69
    • @@ -206,7 +206,7 @@
  • transferList
  • workerId
    • -
    @@ -24,7 +24,7 @@
    • PoolInfo
    +
  • Defined in src/pools/pool.ts:60
    • @@ -60,22 +60,22 @@
    +
  • Defined in src/pools/pool.ts:75

    • Readonly executedTasks

    executedTasks: number
    +
  • Defined in src/pools/pool.ts:76

    • Readonly executingTasks

    executingTasks: number
    +
  • Defined in src/pools/pool.ts:77

    • Readonly failedTasks

    failedTasks: number
    +
  • Defined in src/pools/pool.ts:80

    • Readonly idleWorkerNodes

    idleWorkerNodes: number
    @@ -83,32 +83,32 @@
    +
  • Defined in src/pools/pool.ts:73

    • Optional Readonly maxQueuedTasks

    maxQueuedTasks?: number
    +
  • Defined in src/pools/pool.ts:79

    • Readonly maxSize

    maxSize: number
    +
  • Defined in src/pools/pool.ts:67

    • Readonly minSize

    minSize: number
    +
  • Defined in src/pools/pool.ts:66

    • Optional Readonly queuedTasks

    queuedTasks?: number
    +
  • Defined in src/pools/pool.ts:78

    • Readonly ready

    ready: boolean
    +
  • Defined in src/pools/pool.ts:64

    • Optional Readonly runTime

    runTime?: {
        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 waitTime

    waitTime?: {
        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 workerNodes

    workerNodes: number
    @@ -176,7 +176,7 @@
    +
  • Defined in src/pools/pool.ts:71
    • @@ -215,7 +215,7 @@
  • worker
  • workerNodes
    • -
    @@ -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 enableTasksQueue

    enableTasksQueue?: boolean
    @@ -75,7 +75,7 @@

    Default Value

    false

    +
  • Defined in src/pools/pool.ts:154

    • Optional errorHandler

    errorHandler?: ErrorHandler<Worker>
    @@ -83,7 +83,7 @@
    +
  • Defined in src/pools/pool.ts:120

    • Optional exitHandler

    exitHandler?: ExitHandler<Worker>
    @@ -91,7 +91,7 @@
    +
  • Defined in src/pools/pool.ts:128

    • Optional messageHandler

    messageHandler?: MessageHandler<Worker>
    @@ -99,7 +99,7 @@
    +
  • Defined in src/pools/pool.ts:116

    • Optional onlineHandler

    onlineHandler?: OnlineHandler<Worker>
    @@ -107,7 +107,7 @@
    +
  • Defined in src/pools/pool.ts:124

    • Optional restartWorkerOnError

    restartWorkerOnError?: boolean
    @@ -115,7 +115,7 @@
    +
  • Defined in src/pools/pool.ts:142

    • Optional tasksQueueOptions

    tasksQueueOptions?: TasksQueueOptions
    @@ -123,7 +123,7 @@
    +
  • Defined in src/pools/pool.ts:158

    • Optional workerChoiceStrategy

    workerChoiceStrategy?: "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 workerChoiceStrategyOptions

    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    @@ -141,7 +141,7 @@
    +
  • Defined in src/pools/pool.ts:138
    • @@ -172,7 +172,7 @@
  • workerChoiceStrategy
  • workerChoiceStrategyOptions
    • -
    @@ -32,7 +32,7 @@
    • PromiseResponseWrapper
    +
  • 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 workerNodeKey

    workerNodeKey: number
    @@ -95,7 +95,7 @@
    +
  • Defined in src/utility-types.ts:149
    • @@ -119,7 +119,7 @@
  • resolve
  • workerNodeKey
    • -
    @@ -24,7 +24,7 @@
    • StrategyPolicy
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:148
    • @@ -43,7 +43,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:152
    • @@ -65,7 +65,7 @@
    -
    @@ -34,7 +34,7 @@ +
  • Defined in src/utility-types.ts:65
    • @@ -58,7 +58,7 @@
    +
  • 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 taskId

    taskId?: 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 transferList

    transferList?: TransferListItem[]
    @@ -90,7 +90,7 @@
    +
  • Defined in src/utility-types.ts:81

    • Readonly workerId

    workerId: number
    @@ -98,7 +98,7 @@
    +
  • Defined in src/utility-types.ts:69
    • @@ -125,7 +125,7 @@
  • transferList
  • workerId
    • -
    @@ -32,7 +32,7 @@
    • TaskError
    +
  • Defined in src/utility-types.ts:10
    • @@ -53,7 +53,7 @@
    +
  • 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
    • @@ -93,7 +93,7 @@
  • message
  • name
    • -
    @@ -24,7 +24,7 @@
    • TaskPerformance
    +
  • Defined in src/utility-types.ts:30
    • @@ -46,7 +46,7 @@
    +
  • Defined in src/utility-types.ts:46

    • Readonly name

    name: string
    @@ -54,7 +54,7 @@
    +
  • Defined in src/utility-types.ts:34

    • Optional Readonly runTime

    runTime?: 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
    • @@ -95,7 +95,7 @@
  • runTime
  • timestamp
    • -
    @@ -24,7 +24,7 @@
    • TaskStatistics
    +
  • Defined in src/pools/worker.ts:82
    • @@ -47,7 +47,7 @@
    +
  • 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 maxQueued

    maxQueued?: 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
    • @@ -105,7 +105,7 @@
  • maxQueued
  • queued
    • -
    @@ -24,7 +24,7 @@
    • TaskStatisticsRequirements
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:128
    • @@ -45,7 +45,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:140

    • Readonly runTime

    runTime: MeasurementStatisticsRequirements
    @@ -53,7 +53,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:132

    • Readonly waitTime

    waitTime: MeasurementStatisticsRequirements
    @@ -61,7 +61,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:136
    • @@ -85,7 +85,7 @@
  • runTime
  • waitTime
    • -
    @@ -24,7 +24,7 @@
    • TasksQueueOptions
    +
  • Defined in src/pools/pool.ts:98
    • @@ -45,7 +45,7 @@

    Default Value

    1

    +
  • Defined in src/pools/pool.ts:104
    • @@ -67,7 +67,7 @@
    -
    @@ -26,7 +26,7 @@
    • ThreadPoolOptions
    +
  • Defined in src/pools/thread/fixed.ts:18
    • @@ -58,7 +58,7 @@
    +
  • Defined in src/pools/pool.ts:148

    • Optional enableTasksQueue

    enableTasksQueue?: boolean
    @@ -69,7 +69,7 @@
    +
  • Defined in src/pools/pool.ts:154

    • Optional errorHandler

    errorHandler?: ErrorHandler<Worker>
    @@ -78,7 +78,7 @@
    +
  • Defined in src/pools/pool.ts:120

    • Optional exitHandler

    exitHandler?: ExitHandler<Worker>
    @@ -87,7 +87,7 @@
    +
  • Defined in src/pools/pool.ts:128

    • Optional messageHandler

    messageHandler?: MessageHandler<Worker>
    @@ -96,7 +96,7 @@
    +
  • Defined in src/pools/pool.ts:116

    • Optional onlineHandler

    onlineHandler?: OnlineHandler<Worker>
    @@ -105,7 +105,7 @@
    +
  • Defined in src/pools/pool.ts:124

    • Optional restartWorkerOnError

    restartWorkerOnError?: boolean
    @@ -114,7 +114,7 @@
    +
  • Defined in src/pools/pool.ts:142

    • Optional tasksQueueOptions

    tasksQueueOptions?: TasksQueueOptions
    @@ -123,7 +123,7 @@
    +
  • Defined in src/pools/pool.ts:158

    • Optional workerChoiceStrategy

    workerChoiceStrategy?: "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 workerChoiceStrategyOptions

    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    @@ -143,7 +143,7 @@
    +
  • Defined in src/pools/pool.ts:138

    • Optional workerOptions

    workerOptions?: WorkerOptions
    @@ -153,7 +153,7 @@

    See

    https://nodejs.org/api/worker_threads.html#new-workerfilename-options

    +
  • Defined in src/pools/thread/fixed.ts:24
    • @@ -185,7 +185,7 @@
  • workerChoiceStrategyOptions
  • workerOptions
    • -
    @@ -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 runTime

    runTime?: MeasurementOptions
    @@ -67,7 +67,7 @@

    Default Value

    { median: false }

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:81

    • Optional Readonly waitTime

    waitTime?: MeasurementOptions
    @@ -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
    • @@ -114,7 +114,7 @@ Weight is the tasks maximum average or median runtime in milliseconds.

  • waitTime
  • weights
    • -
    @@ -24,7 +24,7 @@
    • WorkerInfo
    +
  • Defined in src/pools/worker.ts:123
    • @@ -47,7 +47,7 @@
    +
  • Defined in src/pools/worker.ts:135

    • Readonly id

    id: undefined | number
    @@ -55,7 +55,7 @@
    +
  • Defined in src/pools/worker.ts:127

    • Optional messageChannel

    messageChannel?: 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
    • @@ -105,7 +105,7 @@
  • ready
  • type
    • -
    @@ -24,7 +24,7 @@
    • WorkerOptions
    +
  • 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 killBehavior

    killBehavior?: "SOFT" | "HARD"
    @@ -64,7 +64,7 @@

    Default Value

    KillBehaviors.SOFT

    +
  • Defined in src/worker/worker-options.ts:54

    • Optional maxInactiveTime

    maxInactiveTime?: 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
    • @@ -105,7 +105,7 @@ when this timeout expires your tasks is interrupted before completion and remove
  • killBehavior
  • maxInactiveTime
    • -
    @@ -24,7 +24,7 @@
    • WorkerStatistics
    +
  • Defined in src/utility-types.ts:54
    • @@ -41,12 +41,12 @@

    elu

    elu: boolean
    +
  • Defined in src/utility-types.ts:56

    • runTime

    runTime: boolean
    +
  • Defined in src/utility-types.ts:55
    • @@ -69,7 +69,7 @@
  • elu
  • runTime
    • -
    @@ -24,7 +24,7 @@
    • WorkerUsage
    +
  • Defined in src/pools/worker.ts:151
    • @@ -46,7 +46,7 @@
    +
  • Defined in src/pools/worker.ts:167

    • Readonly runTime

    runTime: MeasurementStatistics
    @@ -54,7 +54,7 @@
    +
  • Defined in src/pools/worker.ts:159

    • Readonly tasks

    tasks: TaskStatistics
    @@ -62,7 +62,7 @@
    +
  • Defined in src/pools/worker.ts:155

    • Readonly waitTime

    waitTime: MeasurementStatistics
    @@ -70,7 +70,7 @@
    +
  • Defined in src/pools/worker.ts:163
    • @@ -95,7 +95,7 @@
  • tasks
  • waitTime
    • -
    @@ -40,7 +40,7 @@

    Returns void

    +
  • Defined in src/pools/worker.ts:16
    • @@ -57,7 +57,7 @@

    Theme

    -
    @@ -40,7 +40,7 @@

    Returns void

    +
  • Defined in src/pools/worker.ts:29
    • @@ -57,7 +57,7 @@

    Theme

    -
    @@ -20,7 +20,7 @@
    +
  • Defined in src/worker/worker-options.ts:18
    • @@ -37,7 +37,7 @@

    Theme

    -
    @@ -20,7 +20,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:56
    • @@ -37,7 +37,7 @@

    Theme

    -
    @@ -40,7 +40,7 @@

    Returns void

    +
  • Defined in src/pools/worker.ts:8
    • @@ -57,7 +57,7 @@

    Theme

    -
    @@ -38,7 +38,7 @@

    Returns void

    +
  • Defined in src/pools/worker.ts:24
    • @@ -55,7 +55,7 @@

    Theme

    -
    @@ -20,7 +20,7 @@
    +
  • Defined in src/pools/pool.ts:55
    • @@ -37,7 +37,7 @@

    Theme

    -
    @@ -20,7 +20,7 @@
    +
  • Defined in src/pools/pool.ts:34
    • @@ -37,7 +37,7 @@

    Theme

    -
    @@ -47,7 +47,7 @@ This function must return a promise.

    Returns Promise<Response>

    +
  • Defined in src/worker/task-functions.ts:18
    • @@ -64,7 +64,7 @@ This function must return a promise.

    Theme

    -
    @@ -34,7 +34,7 @@ This function can be synchronous or asynchronous.

    +
  • Defined in src/worker/task-functions.ts:29
    • @@ -51,7 +51,7 @@ This function can be synchronous or asynchronous.

    Theme

    -
    @@ -36,7 +36,7 @@ The value is the function itself.

    +
  • Defined in src/worker/task-functions.ts:42
    • @@ -53,7 +53,7 @@ The value is the function itself.

    Theme

    -
    @@ -46,7 +46,7 @@

    Returns Response

    +
  • Defined in src/worker/task-functions.ts:7
    • @@ -63,7 +63,7 @@

    Theme

    -
    @@ -20,7 +20,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:42
    • @@ -37,7 +37,7 @@

    Theme

    -
    @@ -20,7 +20,7 @@
    +
  • Defined in src/pools/worker.ts:116
    • @@ -37,7 +37,7 @@

    Theme

    -
    @@ -33,7 +33,7 @@
    +
  • Defined in src/worker/worker-options.ts:4
    • @@ -50,7 +50,7 @@

    Theme

    -
    @@ -29,7 +29,7 @@
    Readonly waitTime: "waitTime"
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:47
    • @@ -46,7 +46,7 @@

    Theme

    -
    @@ -33,7 +33,7 @@
    Readonly taskError: "taskError"
    +
  • Defined in src/pools/pool.ts:44
    • @@ -50,7 +50,7 @@

    Theme

    -
    @@ -33,7 +33,7 @@
    +
  • Defined in src/pools/pool.ts:20
    • @@ -50,7 +50,7 @@

    Theme

    -
    @@ -58,7 +58,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:4
    • @@ -75,7 +75,7 @@

    Theme

    -
    @@ -27,7 +27,7 @@
    Readonly thread: "thread"
    +
  • Defined in src/pools/worker.ts:108
    • @@ -44,7 +44,7 @@

    Theme

    -