From: Documentation Bot Date: Tue, 3 Oct 2023 09:54:10 +0000 (+0000) Subject: docs: generate documentation X-Git-Tag: v3.0.0~17^2 X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=66fc6ae43f2e7a308cdba9d5038d07cf49b9cda4;p=poolifier.git docs: generate documentation --- diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 13d1951e8..1009c580e 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,4 +1,4 @@ -AbstractPool | poolifier - v2.7.4
+AbstractPool | poolifier - v2.7.5
  • Preparing search index...
    • -
  • The search index is not available
poolifier - v2.7.4
+
  • The search index is not available
    • poolifier - v2.7.5
    @@ -49,7 +49,7 @@
    • IPool<Worker, Data, Response>
    +
  • Defined in src/pools/abstract-pool.ts:64
    • @@ -202,12 +202,12 @@

    Returns AbstractPool<Worker, Data, Response>

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

    • Properties

    Optional emitter

    -
    emitter?: __module | EventEmitterAsyncResource
    +
    emitter?: EventEmitterAsyncResource

    Event emitter integrated with async resource on which events can be listened to. The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool.

    Events that can currently be listened to:

    @@ -224,7 +224,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:73

    • Protected Readonly filePath

    filePath: string
    @@ -232,7 +232,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:128

    • Protected Optional Readonly max

    max?: number
    @@ -240,7 +240,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:97

    • Protected Readonly numberOfWorkers

    numberOfWorkers: number
    @@ -248,7 +248,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:127

    • Protected Readonly opts

    opts: PoolOptions<Worker>
    @@ -256,7 +256,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:129

    • Protected promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
    @@ -269,7 +269,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:82

    • Private Readonly startTimestamp

    startTimestamp: number
    @@ -277,7 +277,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:117

    • Private started

    started: boolean
    @@ -285,7 +285,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:109

    • Private starting

    starting: boolean
    @@ -293,7 +293,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:113

    • Private Readonly taskFunctions

    taskFunctions: Map<string, TaskFunction<Data, Response>>
    @@ -305,7 +305,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:104

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -313,7 +313,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:88

    • Readonly Internal workerNodes

    workerNodes: IWorkerNode<Worker, Data>[] = []
    @@ -322,7 +322,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:70

    • Accessors

    @@ -336,7 +336,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo

    Returns boolean

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

    • Protected full

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

    • info

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

    • Protected maxSize

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

    • Protected minSize

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

    • Private ready

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

    • Protected Abstract type

      @@ -405,7 +405,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo

      Returns "fixed" | "dynamic"

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

    • Private utilization

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

    • Protected Abstract worker

      @@ -428,7 +428,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo

      Returns "thread" | "cluster"

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

    • Methods

    @@ -461,7 +461,7 @@ If a task function with the same name already exists, it will be overwritten.

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

    • Private addWorkerNode

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

    • Protected afterTaskExecutionHook

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

    • Protected afterWorkerNodeSetup

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

    • Protected beforeTaskExecutionHook

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

    • Private buildTasksQueueOptions

    Returns TasksQueueOptions

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

    • Private checkAndEmitDynamicWorkerCreationEvents

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

    • Private checkAndEmitTaskExecutionEvents

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

    • Private checkAndEmitTaskQueuingEvents

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

    • Private checkMessageWorkerId

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

    • Private checkNumberOfWorkers

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

      numberOfWorkers: number

    Returns void

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

    • Private checkPoolOptions

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

      opts: PoolOptions<Worker>

    Returns void

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

    • Private checkValidWorkerChoiceStrategyOptions

    Returns void

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

    • Private chooseWorkerNode

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

    • Protected createAndSetupDynamicWorkerNode

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

    • Protected createAndSetupWorkerNode

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

    • Protected Abstract createWorker

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

    • Private deleteTaskFunctionWorkerUsages

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

      name: string

    Returns void

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

    • Private dequeueTask

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

      workerNodeKey: number

    Returns undefined | Task<Data>

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

    • Protected Abstract deregisterWorkerMessageListener

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

    • destroy

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

    • Protected Abstract destroyWorkerNode

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

    • enableTasksQueue

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

    • Private enqueueTask

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

      task: Task<Data>

    Returns number

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

    • execute

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

    • Private executeTask

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

    • Protected flushTasksQueue

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

      workerNodeKey: number

    Returns void

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

    • Private flushTasksQueues

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

    • Protected getWorkerInfo

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

    • Private getWorkerNodeKeyByWorker

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

    • Private getWorkerNodeKeyByWorkerId

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

    • Private handleTaskExecutionResponse

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

      message: MessageValue<Response, unknown>

    Returns void

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

    • Private handleWorkerReadyResponse

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

      message: MessageValue<Response, unknown>

    Returns void

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

    • Private hasBackPressure

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

    • hasTaskFunction

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

    • hasWorkerNodeBackPressure

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

    • Private initializeEventEmitter

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

    • Protected internalBusy

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

    • Protected Abstract isMain

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

    • listTaskFunctionNames

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

    • Private redistributeQueuedTasks

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

      workerNodeKey: number

    Returns void

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

    • Protected Abstract registerOnceWorkerMessageListener

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

    • Protected Abstract registerWorkerMessageListener

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

    • removeTaskFunction

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

    • Private removeWorkerNode

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

    • Protected sendKillMessageToWorker

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

      workerNodeKey: number

    Returns Promise<void>

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

    • Protected Abstract sendStartupMessageToWorker

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

    • Private sendStatisticsMessageToWorker

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

    • Private sendTaskFunctionOperationToWorker

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

      message: MessageValue<Data, unknown>

    Returns Promise<boolean>

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

    • Private sendTaskFunctionOperationToWorkers

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

      message: MessageValue<Data, unknown>

    Returns Promise<boolean>

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

    • Protected Abstract sendToWorker

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

    • setDefaultTaskFunction

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

    • Private setTaskStealing

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

    • setTasksQueueOptions

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

    • Private setTasksQueueSize

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

      size: number

    Returns void

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

    • Private setTasksStealingOnBackPressure

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • Private shallCreateDynamicWorker

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

    • Private shallExecuteTask

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

      workerNodeKey: number

    Returns boolean

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

    • Private shallUpdateTaskFunctionWorkerUsage

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

    • start

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

    • Private taskStealingOnEmptyQueue

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

      workerId: number

    Returns void

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

    • Private tasksQueueSize

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

      workerNodeKey: number

    Returns number

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

    • Private tasksStealingOnBackPressure

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

      workerId: number

    Returns void

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

    • Private unsetTaskStealing

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

    • Private unsetTasksStealingOnBackPressure

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

    • Private updateEluWorkerUsage

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

      message: MessageValue<Response, unknown>

    Returns void

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

    • Private updateRunTimeWorkerUsage

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

      message: MessageValue<Response, unknown>

    Returns void

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

    • Private updateTaskStatisticsWorkerUsage

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

      message: MessageValue<Response, unknown>

    Returns void

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

    • Private updateTaskStolenStatisticsWorkerUsage

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

      taskName: string

    Returns void

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

    • Private updateWaitTimeWorkerUsage

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

      task: Task<Data>

    Returns void

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

    • Protected workerListener

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

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

  • updateWaitTimeWorkerUsage
  • workerListener
    • -
    @@ -47,7 +47,7 @@
  • ClusterWorker
  • ThreadWorker
    • +
  • Defined in src/worker/abstract-worker.ts:55
    • @@ -153,7 +153,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:89

    • Properties

    @@ -163,7 +163,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:79

    • Protected Abstract id

    id: number
    @@ -171,7 +171,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:63

    • Protected Readonly isMain

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

    • Protected lastTaskTimestamp

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

    • Private Readonly mainWorker

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

    • Protected opts

    opts: WorkerOptions = DEFAULT_WORKER_OPTIONS
    @@ -203,7 +203,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:94

    • Protected statistics

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

    • Protected taskFunctions

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

    • Methods

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

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

    • asyncId

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

    +
  • Defined in node_modules/.pnpm/@types+node@20.8.2/node_modules/@types/node/async_hooks.d.ts:315

    • Private beginTaskPerformance

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

      Optional name: string

    Returns TaskPerformance

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

    • bind

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

    +
  • Defined in node_modules/.pnpm/@types+node@20.8.2/node_modules/@types/node/async_hooks.d.ts:288

    • Private checkActive

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

    • Private checkMessageWorkerId

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

    • Private checkStatistics

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

    • Private checkTaskFunctions

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

    • Private checkWorkerOptions

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

      opts: WorkerOptions

    Returns void

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

    • emitDestroy

      @@ -386,7 +386,7 @@ never be called.

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

    • Private endTaskPerformance

    Returns TaskPerformance

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

    • Protected getMainWorker

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

    • Protected handleError

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

    • Protected handleKillMessage

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

    • Protected Abstract handleReadyMessage

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

    • Protected handleTaskFunctionOperationMessage

      @@ -484,7 +484,7 @@ never be called.

      message: MessageValue<Data, unknown>

    Returns void

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

    • hasTaskFunction

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

    • listTaskFunctionNames

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

    • Protected messageListener

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

    • removeTaskFunction

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

    • Protected run

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

    • Protected runAsync

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

    • runInAsyncScope

      @@ -653,7 +653,7 @@ then restore the original execution context.

    +
  • Defined in node_modules/.pnpm/@types+node@20.8.2/node_modules/@types/node/async_hooks.d.ts:299

    • Protected runSync

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

    • Protected sendTaskFunctionNamesToMainWorker

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

    • Protected Abstract sendToMainWorker

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

    • setDefaultTaskFunction

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

    • Private startCheckActive

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

    • Private stopCheckActive

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

    • triggerAsyncId

      @@ -760,7 +760,7 @@ then restore the original execution context.

    +
  • Defined in node_modules/.pnpm/@types+node@20.8.2/node_modules/@types/node/async_hooks.d.ts:319

    • Private updateLastTaskTimestamp

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

    • Static bind

      @@ -804,7 +804,7 @@ then restore the original execution context.

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

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

    Returns CircularArray<T>

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

    • 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:11

    • Static Readonly [species]

    [species]: ArrayConstructor

    Returns void

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

    • concat

      @@ -222,7 +222,7 @@ when they will be absent when used in a 'with' statement.

      Inherit Doc

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

    • copyWithin

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

    • entries

      @@ -729,7 +729,7 @@ thisArg is omitted, undefined is used as the this value.

    • Returns boolean

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

    • 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:23

    • 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:80

    • 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:56

    • toLocaleString

      @@ -1341,7 +1341,7 @@ value otherwise. If omitted, the elements are sorted in ascending, ASCII charact

      Inherit Doc

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

    • values

      @@ -1599,7 +1599,7 @@ value otherwise. If omitted, the elements are sorted in ascending, ASCII charact
    • isArray
    • of
    -
    @@ -47,7 +47,7 @@ but the minimum number of workers will be guaranteed.

    • ClusterWorker
    +
  • Defined in src/worker/cluster-worker.ts:21
    • @@ -128,7 +128,7 @@ but the minimum number of workers will be guaranteed.

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

    • Properties

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

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

    • Protected Readonly isMain

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

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

    • Protected lastTaskTimestamp

    lastTaskTimestamp: number
    @@ -157,7 +157,7 @@ but the minimum number of workers will be guaranteed.

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

    • Protected opts

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

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

    • Protected statistics

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

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

    • Protected taskFunctions

    taskFunctions: Map<string, TaskFunction<Data, Response>>
    @@ -184,7 +184,7 @@ but the minimum number of workers will be guaranteed.

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

    • Accessors

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

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

    • Methods

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

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

    • asyncId

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

    +
  • Defined in node_modules/.pnpm/@types+node@20.8.2/node_modules/@types/node/async_hooks.d.ts:315

    • bind

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

    +
  • Defined in node_modules/.pnpm/@types+node@20.8.2/node_modules/@types/node/async_hooks.d.ts:288

    • emitDestroy

      @@ -281,7 +281,7 @@ never be called.

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

    • Protected getMainWorker

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

    • Protected handleError

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

    • Protected handleKillMessage

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

    • Protected handleReadyMessage

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

    • Protected handleTaskFunctionOperationMessage

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

    • hasTaskFunction

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

    • listTaskFunctionNames

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

    • Protected messageListener

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

    • removeTaskFunction

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

    • Protected run

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

    • Protected runAsync

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

    • runInAsyncScope

      @@ -546,7 +546,7 @@ then restore the original execution context.

    +
  • Defined in node_modules/.pnpm/@types+node@20.8.2/node_modules/@types/node/async_hooks.d.ts:299

    • Protected runSync

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

    • Protected sendTaskFunctionNamesToMainWorker

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

    • Protected sendToMainWorker

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

    • setDefaultTaskFunction

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

    • triggerAsyncId

      @@ -635,7 +635,7 @@ then restore the original execution context.

    +
  • Defined in node_modules/.pnpm/@types+node@20.8.2/node_modules/@types/node/async_hooks.d.ts:319

    • Static bind

      @@ -671,7 +671,7 @@ then restore the original execution context.

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

  • triggerAsyncId
  • bind
    • -
    @@ -33,7 +33,7 @@ Implemented with a doubly linked list.

    • Deque
    +
  • Defined in src/deque.ts:26
    • @@ -77,14 +77,14 @@ Implemented with a doubly linked list.

    T

    Returns Deque<T>

    +
  • Defined in src/deque.ts:34

    • Properties

    Private Optional head

    head?: Node<T>
    +
  • Defined in src/deque.ts:27

    • maxSize

    maxSize: number
    @@ -92,7 +92,7 @@ Implemented with a doubly linked list.

    +
  • Defined in src/deque.ts:32

    • size

    size: number
    @@ -100,12 +100,12 @@ Implemented with a doubly linked list.

    +
  • Defined in src/deque.ts:30

    • Private Optional tail

    tail?: Node<T>
    +
  • Defined in src/deque.ts:28

    • Methods

    @@ -121,7 +121,7 @@ Implemented with a doubly linked list.

    See

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

    +
  • Defined in src/deque.ts:144

    • backward

    +
  • Defined in src/deque.ts:170

    • clear

      @@ -146,7 +146,7 @@ Implemented with a doubly linked list.

      Returns void

    +
  • Defined in src/deque.ts:131

    • Private incrementSize

      @@ -154,7 +154,7 @@ Implemented with a doubly linked list.

    • Returns number

    +
  • Defined in src/deque.ts:194

    • peekFirst

      @@ -166,7 +166,7 @@ Implemented with a doubly linked list.

    +
  • Defined in src/deque.ts:116

    • peekLast

      @@ -178,7 +178,7 @@ Implemented with a doubly linked list.

    +
  • Defined in src/deque.ts:124

    • pop

      @@ -190,7 +190,7 @@ Implemented with a doubly linked list.

    +
  • Defined in src/deque.ts:77

    • push

      @@ -210,7 +210,7 @@ Implemented with a doubly linked list.

    +
  • Defined in src/deque.ts:44

    • shift

      @@ -222,7 +222,7 @@ Implemented with a doubly linked list.

    +
  • Defined in src/deque.ts:97

    • unshift

      @@ -242,7 +242,7 @@ Implemented with a doubly linked list.

    +
  • Defined in src/deque.ts:61
    • @@ -278,7 +278,7 @@ Implemented with a doubly linked list.

  • shift
  • unshift
    • -
    @@ -45,7 +45,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    • DynamicClusterPool
    +
  • Defined in src/pools/cluster/dynamic.ts:16
    • @@ -156,12 +156,12 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/cluster/dynamic.ts:28

    • Properties

    Optional emitter

    -
    emitter?: __module | EventEmitterAsyncResource
    +
    emitter?: EventEmitterAsyncResource

    Event emitter integrated with async resource on which events can be listened to. The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool.

    Events that can currently be listened to:

    @@ -178,7 +178,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:73

    • Protected Readonly filePath

    filePath: string
    @@ -187,7 +187,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:128

    • Protected Readonly max

    max: number
    @@ -196,7 +196,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/cluster/dynamic.ts:30

    • Protected Readonly numberOfWorkers

    numberOfWorkers: number
    @@ -205,7 +205,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:127

    • Protected Readonly opts

    opts: ClusterPoolOptions = {}
    @@ -214,7 +214,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/cluster/fixed.ts:47

    • Protected promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
    @@ -228,7 +228,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:82

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -237,7 +237,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:88

    • Readonly Internal workerNodes

    workerNodes: IWorkerNode<Worker, Data>[] = []
    @@ -246,7 +246,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:70

    • Accessors

    @@ -261,7 +261,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/cluster/dynamic.ts:44

    • Protected full

      @@ -274,7 +274,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:651

    • info

      @@ -286,7 +286,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:271

    • Protected maxSize

      @@ -298,7 +298,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:484

    • Protected minSize

      @@ -310,7 +310,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:477

    • Private ready

      @@ -322,7 +322,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:429

    • Protected type

      @@ -335,7 +335,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/cluster/dynamic.ts:39

    • Private utilization

      @@ -348,7 +348,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:446

    • Protected worker

      @@ -360,7 +360,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/cluster/fixed.ts:134

    • Methods

    @@ -393,7 +393,7 @@ If a task function with the same name already exists, it will be overwritten.

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

    • Protected afterTaskExecutionHook

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

    • Protected afterWorkerNodeSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected createAndSetupDynamicWorkerNode

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

    • Protected createAndSetupWorkerNode

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

    • Protected createWorker

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

    • Protected deregisterWorkerMessageListener

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

    • destroy

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

    • Protected destroyWorkerNode

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

    • enableTasksQueue

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

    • execute

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

    • Protected flushTasksQueue

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

    • Protected getWorkerInfo

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

    • hasTaskFunction

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

    • hasWorkerNodeBackPressure

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

    • Protected internalBusy

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

    • Protected isMain

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

    • listTaskFunctionNames

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

    • Protected registerOnceWorkerMessageListener

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

    • Protected registerWorkerMessageListener

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

    • removeTaskFunction

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

    • Protected sendKillMessageToWorker

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

    • Protected sendStartupMessageToWorker

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

    • Protected sendToWorker

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

    • setDefaultTaskFunction

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

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • start

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

    • Protected workerListener

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

  • start
  • workerListener
    • -
    @@ -45,7 +45,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    • DynamicThreadPool
    +
  • Defined in src/pools/thread/dynamic.ts:16
    • @@ -156,12 +156,12 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/thread/dynamic.ts:28

    • Properties

    Optional emitter

    -
    emitter?: __module | EventEmitterAsyncResource
    +
    emitter?: EventEmitterAsyncResource

    Event emitter integrated with async resource on which events can be listened to. The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool.

    Events that can currently be listened to:

    @@ -178,7 +178,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:73

    • Protected Readonly filePath

    filePath: string
    @@ -187,7 +187,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:128

    • Protected Readonly max

    max: number
    @@ -196,7 +196,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/thread/dynamic.ts:30

    • Protected Readonly numberOfWorkers

    numberOfWorkers: number
    @@ -205,7 +205,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:127

    • Protected Readonly opts

    opts: ThreadPoolOptions = {}
    @@ -214,7 +214,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/thread/fixed.ts:49

    • Protected promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
    @@ -228,7 +228,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:82

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -237,7 +237,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:88

    • Readonly Internal workerNodes

    workerNodes: IWorkerNode<Worker, Data>[] = []
    @@ -246,7 +246,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:70

    • Accessors

    @@ -261,7 +261,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/thread/dynamic.ts:44

    • Protected full

      @@ -274,7 +274,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:651

    • info

      @@ -286,7 +286,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:271

    • Protected maxSize

      @@ -298,7 +298,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:484

    • Protected minSize

      @@ -310,7 +310,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:477

    • Private ready

      @@ -322,7 +322,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:429

    • Protected type

      @@ -335,7 +335,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/thread/dynamic.ts:39

    • Private utilization

      @@ -348,7 +348,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:446

    • Protected worker

      @@ -360,7 +360,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/thread/fixed.ts:149

    • Methods

    @@ -393,7 +393,7 @@ If a task function with the same name already exists, it will be overwritten.

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

    • Protected afterTaskExecutionHook

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

    • Protected afterWorkerNodeSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected createAndSetupDynamicWorkerNode

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

    • Protected createAndSetupWorkerNode

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

    • Protected createWorker

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

    • Protected deregisterWorkerMessageListener

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

    • destroy

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

    • Protected destroyWorkerNode

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

    • enableTasksQueue

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

    • execute

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

    • Protected flushTasksQueue

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

    • Protected getWorkerInfo

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

    • hasTaskFunction

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

    • hasWorkerNodeBackPressure

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

    • Protected internalBusy

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

    • Protected isMain

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

    • listTaskFunctionNames

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

    • Protected registerOnceWorkerMessageListener

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

    • Protected registerWorkerMessageListener

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

    • removeTaskFunction

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

    • Protected sendKillMessageToWorker

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

    • Protected sendStartupMessageToWorker

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

    • Protected sendToWorker

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

    • setDefaultTaskFunction

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

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • start

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

    • Protected workerListener

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

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

    • Properties

    Optional emitter

    -
    emitter?: __module | EventEmitterAsyncResource
    +
    emitter?: EventEmitterAsyncResource

    Event emitter integrated with async resource on which events can be listened to. The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool.

    Events that can currently be listened to:

    @@ -173,7 +173,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:73

    • Protected Readonly filePath

    filePath: string
    @@ -182,7 +182,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:128

    • Protected Optional Readonly max

    max?: number
    @@ -191,7 +191,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:97

    • Protected Readonly numberOfWorkers

    numberOfWorkers: number
    @@ -200,7 +200,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:127

    • Protected Readonly opts

    opts: ClusterPoolOptions = {}
    @@ -209,7 +209,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/cluster/fixed.ts:47

    • Protected promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
    @@ -223,7 +223,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:82

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -232,7 +232,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:88

    • Readonly Internal workerNodes

    workerNodes: IWorkerNode<Worker, Data>[] = []
    @@ -241,7 +241,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:70

    • Accessors

    @@ -256,7 +256,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/cluster/fixed.ts:139

    • Protected full

      @@ -269,7 +269,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:651

    • info

      @@ -281,7 +281,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:271

    • Protected maxSize

      @@ -293,7 +293,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:484

    • Protected minSize

      @@ -305,7 +305,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:477

    • Private ready

      @@ -317,7 +317,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:429

    • Protected type

      @@ -330,7 +330,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/cluster/fixed.ts:129

    • Private utilization

      @@ -343,7 +343,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:446

    • Protected worker

      @@ -355,7 +355,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/cluster/fixed.ts:134

    • Methods

    @@ -388,7 +388,7 @@ If a task function with the same name already exists, it will be overwritten.

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

    • Protected afterTaskExecutionHook

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

    • Protected afterWorkerNodeSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected createAndSetupDynamicWorkerNode

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

    • Protected createAndSetupWorkerNode

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

    • Protected createWorker

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

    • Protected deregisterWorkerMessageListener

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

    • destroy

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

    • Protected destroyWorkerNode

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

    • enableTasksQueue

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

    • execute

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

    • Protected flushTasksQueue

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

    • Protected getWorkerInfo

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

    • hasTaskFunction

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

    • hasWorkerNodeBackPressure

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

    • Protected internalBusy

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

    • Protected isMain

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

    • listTaskFunctionNames

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

    • Protected registerOnceWorkerMessageListener

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

    • Protected registerWorkerMessageListener

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

    • removeTaskFunction

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

    • Protected sendKillMessageToWorker

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

    • Protected sendStartupMessageToWorker

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

    • Protected sendToWorker

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

    • setDefaultTaskFunction

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

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • start

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

    • Protected workerListener

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

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

    • Properties

    Optional emitter

    -
    emitter?: __module | EventEmitterAsyncResource
    +
    emitter?: EventEmitterAsyncResource

    Event emitter integrated with async resource on which events can be listened to. The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool.

    Events that can currently be listened to:

    @@ -173,7 +173,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:73

    • Protected Readonly filePath

    filePath: string
    @@ -182,7 +182,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:128

    • Protected Optional Readonly max

    max?: number
    @@ -191,7 +191,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:97

    • Protected Readonly numberOfWorkers

    numberOfWorkers: number
    @@ -200,7 +200,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:127

    • Protected Readonly opts

    opts: ThreadPoolOptions = {}
    @@ -209,7 +209,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/thread/fixed.ts:49

    • Protected promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
    @@ -223,7 +223,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:82

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -232,7 +232,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:88

    • Readonly Internal workerNodes

    workerNodes: IWorkerNode<Worker, Data>[] = []
    @@ -241,7 +241,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:70

    • Accessors

    @@ -256,7 +256,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/thread/fixed.ts:154

    • Protected full

      @@ -269,7 +269,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:651

    • info

      @@ -281,7 +281,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:271

    • Protected maxSize

      @@ -293,7 +293,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:484

    • Protected minSize

      @@ -305,7 +305,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:477

    • Private ready

      @@ -317,7 +317,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:429

    • Protected type

      @@ -330,7 +330,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/thread/fixed.ts:144

    • Private utilization

      @@ -343,7 +343,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:446

    • Protected worker

      @@ -355,7 +355,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/thread/fixed.ts:149

    • Methods

    @@ -388,7 +388,7 @@ If a task function with the same name already exists, it will be overwritten.

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

    • Protected afterTaskExecutionHook

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

    • Protected afterWorkerNodeSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected createAndSetupDynamicWorkerNode

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

    • Protected createAndSetupWorkerNode

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

    • Protected createWorker

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

    • Protected deregisterWorkerMessageListener

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

    • destroy

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

    • Protected destroyWorkerNode

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

    • enableTasksQueue

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

    • execute

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

    • Protected flushTasksQueue

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

    • Protected getWorkerInfo

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

    • hasTaskFunction

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

    • hasWorkerNodeBackPressure

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

    • Protected internalBusy

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

    • Protected isMain

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

    • listTaskFunctionNames

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

    • Protected registerOnceWorkerMessageListener

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

    • Protected registerWorkerMessageListener

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

    • removeTaskFunction

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

    • Protected sendKillMessageToWorker

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

    • Protected sendStartupMessageToWorker

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

    • Protected sendToWorker

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

    • setDefaultTaskFunction

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

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • start

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

    • Protected workerListener

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

  • start
  • workerListener
    • -
    @@ -32,7 +32,7 @@
    • Node
    +
  • Defined in src/deque.ts:9
    • @@ -67,24 +67,24 @@
    data: T

    Returns Node<T>

    +
  • Defined in src/deque.ts:14

    • Properties

    data

    data: T
    +
  • Defined in src/deque.ts:10

    • Optional next

    next?: Node<T>
    +
  • Defined in src/deque.ts:11

    • Optional prev

    prev?: Node<T>
    +
  • Defined in src/deque.ts:12
    • @@ -109,7 +109,7 @@
  • next
  • prev
    • -
    @@ -47,7 +47,7 @@ but the minimum number of workers will be guaranteed.

    • ThreadWorker
    +
  • Defined in src/worker/thread-worker.ts:26
    • @@ -129,7 +129,7 @@ but the minimum number of workers will be guaranteed.

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

    • Properties

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

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

    • Protected Readonly isMain

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

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

    • Protected lastTaskTimestamp

    lastTaskTimestamp: number
    @@ -158,7 +158,7 @@ but the minimum number of workers will be guaranteed.

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

    • Protected opts

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

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

    • Private port

    port: MessagePort
    @@ -175,7 +175,7 @@ but the minimum number of workers will be guaranteed.

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

    • Protected statistics

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

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

    • Protected taskFunctions

    taskFunctions: Map<string, TaskFunction<Data, Response>>
    @@ -193,7 +193,7 @@ but the minimum number of workers will be guaranteed.

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

    • Accessors

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

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

    • Methods

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

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

    • asyncId

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

    +
  • Defined in node_modules/.pnpm/@types+node@20.8.2/node_modules/@types/node/async_hooks.d.ts:315

    • bind

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

    +
  • Defined in node_modules/.pnpm/@types+node@20.8.2/node_modules/@types/node/async_hooks.d.ts:288

    • emitDestroy

      @@ -290,7 +290,7 @@ never be called.

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

    • Protected getMainWorker

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

    • Protected handleError

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

    • Protected handleKillMessage

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

    • Protected handleReadyMessage

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

    • Protected handleTaskFunctionOperationMessage

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

    • hasTaskFunction

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

    • listTaskFunctionNames

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

    • Protected messageListener

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

    • removeTaskFunction

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

    • Protected run

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

    • Protected runAsync

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

    • runInAsyncScope

      @@ -555,7 +555,7 @@ then restore the original execution context.

    +
  • Defined in node_modules/.pnpm/@types+node@20.8.2/node_modules/@types/node/async_hooks.d.ts:299

    • Protected runSync

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

    • Protected sendTaskFunctionNamesToMainWorker

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

    • Protected sendToMainWorker

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

    • setDefaultTaskFunction

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

    • triggerAsyncId

      @@ -644,7 +644,7 @@ then restore the original execution context.

    +
  • Defined in node_modules/.pnpm/@types+node@20.8.2/node_modules/@types/node/async_hooks.d.ts:319

    • Static bind

      @@ -680,7 +680,7 @@ then restore the original execution context.

    +
  • Defined in node_modules/.pnpm/@types+node@20.8.2/node_modules/@types/node/async_hooks.d.ts:278
    • @@ -732,7 +732,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
    • @@ -108,7 +108,7 @@

    Returns WorkerChoiceStrategyContext<Worker, Data, Response>

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

    • Properties

    @@ -118,7 +118,7 @@
    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:52

    • Private retriesCount

    retriesCount: number = 0
    @@ -126,12 +126,12 @@
    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:40

    • 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
    @@ -139,7 +139,7 @@
    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:51

    • Methods

    @@ -155,7 +155,7 @@

    Throws

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

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

    • getStrategyPolicy

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

    • getTaskStatisticsRequirements

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

    • remove

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

    • setOptions

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

    • setWorkerChoiceStrategy

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

    • update

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

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

    Theme

    -
    -

    poolifier - v2.7.4

    +

    poolifier - v2.7.5

    Index

    @@ -110,7 +110,7 @@

    Theme

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

    • Optional enableTasksQueue

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

    • Optional env

    env?: Record<string, unknown>
    @@ -83,7 +83,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>
    @@ -94,7 +94,7 @@
    +
  • Defined in src/pools/pool.ts:149

    • Optional exitHandler

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

    • Optional messageHandler

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

    • Optional onlineHandler

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

    • Optional restartWorkerOnError

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

    • Optional settings

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

    See

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

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

    • Optional startWorkers

    startWorkers?: boolean
    @@ -158,7 +158,7 @@
    +
  • Defined in src/pools/pool.ts:161

    • Optional tasksQueueOptions

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

    • Optional workerChoiceStrategy

    workerChoiceStrategy?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
    @@ -179,7 +179,7 @@
    +
  • Defined in src/pools/pool.ts:167

    • Optional workerChoiceStrategyOptions

    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    @@ -188,7 +188,7 @@
    +
  • Defined in src/pools/pool.ts:171
    • @@ -222,7 +222,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:201
    • @@ -107,7 +107,7 @@ If a task function with the same name already exists, it will be overwritten.

    Throws

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

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

    • Readonly destroy

    destroy: (() => Promise<void>)
    @@ -123,10 +123,10 @@ If a task function with the same name already exists, it will be overwritten.

    Returns Promise<void>
    +
  • Defined in src/pools/pool.ts:259

    • Optional Readonly emitter

    -
    emitter?: __module | EventEmitterAsyncResource
    +
    emitter?: EventEmitterAsyncResource

    Event emitter integrated with async resource on which events can be listened to. The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool.

    Events that can currently be listened to:

    @@ -142,7 +142,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/pool.ts:238

    • Readonly enableTasksQueue

    enableTasksQueue: ((enable, tasksQueueOptions?) => void)
    @@ -171,7 +171,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo

    Returns void

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

    • Readonly execute

    execute: ((data?, name?, transferList?) => Promise<Response>)
    @@ -206,7 +206,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/pool.ts:247

    • Readonly hasTaskFunction

    hasTaskFunction: ((name) => boolean)
    @@ -231,7 +231,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/pool.ts:266

    • Readonly hasWorkerNodeBackPressure

    hasWorkerNodeBackPressure: ((workerNodeKey) => boolean)
    @@ -256,7 +256,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/pool.ts:223

    • Readonly info

    info: PoolInfo
    @@ -264,7 +264,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/pool.ts:209

    • Readonly listTaskFunctionNames

    listTaskFunctionNames: (() => string[])
    @@ -281,7 +281,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/pool.ts:293

    • Readonly removeTaskFunction

    removeTaskFunction: ((name) => Promise<boolean>)
    @@ -306,7 +306,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/pool.ts:287

    • Readonly setDefaultTaskFunction

    setDefaultTaskFunction: ((name) => Promise<boolean>)
    @@ -331,7 +331,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/pool.ts:300

    • Readonly setTasksQueueOptions

    setTasksQueueOptions: ((tasksQueueOptions) => void)
    @@ -355,7 +355,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo

    Returns void

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

    • Readonly setWorkerChoiceStrategy

    setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void)
    @@ -384,7 +384,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo

    Returns void

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

    • Readonly setWorkerChoiceStrategyOptions

    setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)
    @@ -408,7 +408,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo

    Returns void

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

    • Readonly start

    start: (() => void)
    @@ -424,7 +424,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo

    Returns void

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

    • Readonly Internal workerNodes

    workerNodes: IWorkerNode<Worker, Data>[]
    @@ -432,7 +432,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/pool.ts:215
    • @@ -469,7 +469,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
  • start
  • workerNodes
    • -
    @@ -24,7 +24,7 @@
    • IWorker
    +
  • Defined in src/pools/worker.ts:186
    • @@ -46,7 +46,7 @@
    +
  • Defined in src/pools/worker.ts:190

    • 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:198

    • Readonly once

    once: ((event, handler) => void)
    @@ -147,12 +147,12 @@

    Returns void

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

    • Optional Readonly threadId

    threadId?: number
    +
  • Defined in src/pools/worker.ts:191
    • @@ -177,7 +177,7 @@
  • once
  • threadId
    • -
    @@ -24,7 +24,7 @@
    • IWorkerChoiceStrategy
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:168
    • @@ -60,7 +60,7 @@ If undefined is returned, the caller retry.

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

    • Readonly remove

    remove: ((workerNodeKey) => boolean)
    @@ -85,7 +85,7 @@ If undefined is returned, the caller retry.

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

    • Readonly reset

    reset: (() => boolean)
    @@ -102,7 +102,7 @@ If undefined is returned, the caller retry.

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

    • Readonly setOptions

    setOptions: ((opts) => void)
    @@ -126,7 +126,7 @@ If undefined is returned, the caller retry.

    Returns void

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

    • Readonly strategyPolicy

    strategyPolicy: StrategyPolicy
    @@ -134,7 +134,7 @@ If undefined is returned, the caller retry.

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

    • Readonly taskStatisticsRequirements

    taskStatisticsRequirements: TaskStatisticsRequirements
    @@ -142,7 +142,7 @@ If undefined is returned, the caller retry.

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

    • Readonly update

    update: ((workerNodeKey) => boolean)
    @@ -165,7 +165,7 @@ This is called after a task has been executed on a worker node.

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:189
    • @@ -193,7 +193,7 @@ This is called after a task has been executed on a worker node.

  • taskStatisticsRequirements
  • update
    • -
    @@ -37,7 +37,7 @@
    • IWorkerNode
    +
  • Defined in src/pools/worker.ts:226
    • @@ -82,7 +82,7 @@

    Returns void

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

    • Readonly closeChannel

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

    Returns void

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

    • Readonly deleteTaskFunctionWorkerUsage

    deleteTaskFunctionWorkerUsage: ((name) => boolean)
    @@ -123,7 +123,7 @@
    +
  • Defined in src/pools/worker.ts:324

    • Readonly dequeueTask

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

    • Readonly enqueueTask

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

    • Readonly getTaskFunctionWorkerUsage

    getTaskFunctionWorkerUsage: ((name) => undefined | WorkerUsage)
    @@ -190,7 +190,7 @@
    +
  • Defined in src/pools/worker.ts:317

    • Readonly hasBackPressure

    hasBackPressure: (() => boolean)
    @@ -207,7 +207,7 @@
    +
  • Defined in src/pools/worker.ts:302

    • Readonly info

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

    • Optional Readonly messageChannel

    messageChannel?: MessageChannel
    @@ -223,7 +223,7 @@
    +
  • Defined in src/pools/worker.ts:247

    • Optional onBackPressure

    onBackPressure?: WorkerNodeEventCallback
    @@ -231,7 +231,7 @@
    +
  • Defined in src/pools/worker.ts:256

    • Optional onEmptyQueue

    onEmptyQueue?: WorkerNodeEventCallback
    @@ -239,7 +239,7 @@
    +
  • Defined in src/pools/worker.ts:260

    • Readonly popTask

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

    • Readonly resetUsage

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

    Returns void

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

    • Optional strategyData

    strategyData?: StrategyData
    @@ -281,7 +281,7 @@ This is used to store data that is specific to the worker choice strategy.

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

    • tasksQueueBackPressureSize

    tasksQueueBackPressureSize: number
    @@ -290,7 +290,7 @@ This is the number of tasks that can be enqueued before the worker node has back
    +
  • Defined in src/pools/worker.ts:252

    • Readonly tasksQueueSize

    tasksQueueSize: (() => number)
    @@ -307,7 +307,7 @@ This is the number of tasks that can be enqueued before the worker node has back
    +
  • Defined in src/pools/worker.ts:266

    • Readonly unshiftTask

    unshiftTask: ((task) => number)
    @@ -332,7 +332,7 @@ This is the number of tasks that can be enqueued before the worker node has back
    +
  • Defined in src/pools/worker.ts:280

    • Readonly usage

    usage: WorkerUsage
    @@ -340,7 +340,7 @@ This is the number of tasks that can be enqueued before the worker node has back
    +
  • Defined in src/pools/worker.ts:238

    • Readonly worker

    worker: Worker
    @@ -348,7 +348,7 @@ This is the number of tasks that can be enqueued before the worker node has back
    +
  • Defined in src/pools/worker.ts:230
    • @@ -388,7 +388,7 @@ This is the number of tasks that can be enqueued before the worker node has back
  • usage
  • worker
    • -
    @@ -24,7 +24,7 @@
    • MeasurementOptions
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:59
    • @@ -43,7 +43,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:63
    • @@ -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:112
    • @@ -45,7 +45,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:116

    • average

    average: boolean
    @@ -53,7 +53,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:120

    • median

    median: boolean
    @@ -61,7 +61,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:124
    • @@ -85,7 +85,7 @@
  • average
  • median
    • -
    @@ -39,7 +39,7 @@
    • MessageValue
    +
  • Defined in src/utility-types.ts:105
    • @@ -75,7 +75,7 @@
    +
  • Defined in src/utility-types.ts:153

    • Optional Readonly data

    data?: Data
    @@ -84,7 +84,7 @@
    +
  • Defined in src/utility-types.ts:83

    • Optional Readonly kill

    kill?: true | "success" | "SOFT" | "HARD" | "failure"
    @@ -92,7 +92,7 @@
    +
  • Defined in src/utility-types.ts:110

    • Optional Readonly name

    name?: string
    @@ -101,7 +101,7 @@
    +
  • Defined in src/utility-types.ts:79

    • Optional Readonly port

    port?: MessagePort
    @@ -109,7 +109,7 @@
    +
  • Defined in src/utility-types.ts:157

    • Optional Readonly ready

    ready?: boolean
    @@ -117,7 +117,7 @@
    +
  • Defined in src/utility-types.ts:149

    • Optional Readonly statistics

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

    • Optional Readonly taskFunction

    taskFunction?: string
    @@ -133,7 +133,7 @@
    +
  • Defined in src/utility-types.ts:133

    • Optional Readonly taskFunctionName

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

    • Optional Readonly taskFunctionNames

    taskFunctionNames?: string[]
    @@ -149,7 +149,7 @@
    +
  • Defined in src/utility-types.ts:141

    • Optional Readonly taskFunctionOperation

    taskFunctionOperation?: "add" | "default" | "remove"
    @@ -162,7 +162,7 @@
    +
  • Defined in src/utility-types.ts:125

    • Optional Readonly taskFunctionOperationStatus

    taskFunctionOperationStatus?: boolean
    @@ -170,7 +170,7 @@
    +
  • Defined in src/utility-types.ts:129

    • Optional Readonly taskId

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

    • Optional Readonly taskPerformance

    taskPerformance?: TaskPerformance
    @@ -187,7 +187,7 @@
    +
  • Defined in src/utility-types.ts:118

    • Optional Readonly timestamp

    timestamp?: number
    @@ -196,7 +196,7 @@
    +
  • Defined in src/utility-types.ts:91

    • Optional Readonly transferList

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

    • Optional Readonly workerError

    workerError?: WorkerError<ErrorData>
    @@ -213,7 +213,7 @@
    +
  • Defined in src/utility-types.ts:114

    • Optional Readonly workerId

    workerId?: number
    @@ -222,7 +222,7 @@
    +
  • Defined in src/utility-types.ts:75
    • @@ -261,7 +261,7 @@
  • workerError
  • workerId
    • -
    @@ -24,7 +24,7 @@
    • PoolInfo
    +
  • Defined in src/pools/pool.ts:58
    • @@ -60,7 +60,7 @@

    Optional Readonly backPressure

    backPressure?: boolean
    +
  • Defined in src/pools/pool.ts:79

    • Readonly busyWorkerNodes

    busyWorkerNodes: number
    @@ -68,22 +68,22 @@
    +
  • Defined in src/pools/pool.ts:74

    • Readonly executedTasks

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

    • Readonly executingTasks

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

    • Readonly failedTasks

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

    • Readonly idleWorkerNodes

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

    • Optional Readonly maxQueuedTasks

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

    • Readonly maxSize

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

    • Readonly minSize

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

    • Optional Readonly queuedTasks

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

    • Readonly ready

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

    • Optional Readonly runTime

    runTime?: {
        average?: number;
        maximum: number;
        median?: number;
        minimum: number;
    }
    @@ -132,27 +132,27 @@
  • Readonly minimum: number
    • +
  • Defined in src/pools/pool.ts:82

    • Readonly started

    started: boolean
    +
  • Defined in src/pools/pool.ts:62

    • Optional Readonly stolenTasks

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

    • 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:64

    • Readonly type

    type: "fixed" | "dynamic"
    +
  • Defined in src/pools/pool.ts:60

    • Optional Readonly utilization

    utilization?: number
    @@ -160,12 +160,12 @@
    +
  • Defined in src/pools/pool.ts:68

    • Readonly version

    version: string
    +
  • Defined in src/pools/pool.ts:59

    • Optional Readonly waitTime

    waitTime?: {
        average?: number;
        maximum: number;
        median?: number;
        minimum: number;
    }
    @@ -181,12 +181,12 @@
  • Readonly minimum: number
    • +
  • Defined in src/pools/pool.ts:88

    • Readonly worker

    worker: "thread" | "cluster"
    +
  • Defined in src/pools/pool.ts:61

    • Readonly workerNodes

    workerNodes: number
    @@ -194,7 +194,7 @@
    +
  • Defined in src/pools/pool.ts:70
    • @@ -236,7 +236,7 @@
  • worker
  • workerNodes
    • -
    @@ -35,7 +35,7 @@
  • ClusterPoolOptions
  • ThreadPoolOptions
    • +
  • Defined in src/pools/pool.ts:131
    • @@ -67,7 +67,7 @@
    +
  • Defined in src/pools/pool.ts:181

    • Optional enableTasksQueue

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

    • Optional errorHandler

    errorHandler?: ErrorHandler<Worker>
    @@ -88,7 +88,7 @@

    Default Value

    () => {}

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

    • Optional exitHandler

    exitHandler?: ExitHandler<Worker>
    @@ -98,7 +98,7 @@

    Default Value

    () => {}

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

    • Optional messageHandler

    messageHandler?: MessageHandler<Worker>
    @@ -108,7 +108,7 @@

    Default Value

    () => {}

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

    • Optional onlineHandler

    onlineHandler?: OnlineHandler<Worker>
    @@ -118,7 +118,7 @@

    Default Value

    () => {}

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

    • Optional restartWorkerOnError

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

    • Optional startWorkers

    startWorkers?: boolean
    @@ -137,7 +137,7 @@
    +
  • Defined in src/pools/pool.ts:161

    • Optional tasksQueueOptions

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

    • Optional workerChoiceStrategy

    workerChoiceStrategy?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
    @@ -156,7 +156,7 @@
    +
  • Defined in src/pools/pool.ts:167

    • Optional workerChoiceStrategyOptions

    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    @@ -164,7 +164,7 @@
    +
  • Defined in src/pools/pool.ts:171
    • @@ -196,7 +196,7 @@
  • workerChoiceStrategy
  • workerChoiceStrategyOptions
    • -
    @@ -32,7 +32,7 @@
    • PromiseResponseWrapper
    +
  • Defined in src/utility-types.ts:166
    • @@ -66,7 +66,7 @@

    Returns void

    +
  • Defined in src/utility-types.ts:174

    • Readonly resolve

    resolve: ((value) => void)
    @@ -87,7 +87,7 @@

    Returns void

    +
  • Defined in src/utility-types.ts:170

    • Readonly workerNodeKey

    workerNodeKey: number
    @@ -95,7 +95,7 @@
    +
  • Defined in src/utility-types.ts:178
    • @@ -119,7 +119,7 @@
  • resolve
  • workerNodeKey
    • -
    @@ -24,7 +24,7 @@
    • StrategyData
    +
  • Defined in src/pools/worker.ts:179
    • @@ -40,7 +40,7 @@

    Optional virtualTaskEndTimestamp

    virtualTaskEndTimestamp?: number
    +
  • Defined in src/pools/worker.ts:180
    • @@ -62,7 +62,7 @@
    -
    @@ -24,7 +24,7 @@
    • StrategyPolicy
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:152
    • @@ -44,7 +44,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:160

    • Readonly dynamicWorkerUsage

    dynamicWorkerUsage: boolean
    @@ -52,7 +52,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:156
    • @@ -75,7 +75,7 @@
  • dynamicWorkerReady
  • dynamicWorkerUsage
    • -
    @@ -34,7 +34,7 @@ +
  • Defined in src/utility-types.ts:71
    • @@ -58,7 +58,7 @@
    +
  • Defined in src/utility-types.ts:83

    • Optional Readonly name

    name?: string
    @@ -66,7 +66,7 @@
    +
  • Defined in src/utility-types.ts:79

    • Optional Readonly taskId

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

    • Optional Readonly timestamp

    timestamp?: number
    @@ -82,7 +82,7 @@
    +
  • Defined in src/utility-types.ts:91

    • Optional Readonly transferList

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

    • Optional Readonly workerId

    workerId?: number
    @@ -98,7 +98,7 @@
    +
  • Defined in src/utility-types.ts:75
    • @@ -125,7 +125,7 @@
  • transferList
  • workerId
    • -
    @@ -24,7 +24,7 @@
    • TaskFunctionOperationResult
    +
  • Defined in src/worker/task-functions.ts:50
    • @@ -41,12 +41,12 @@

    Optional error

    error?: Error
    +
  • Defined in src/worker/task-functions.ts:52

    • status

    status: boolean
    +
  • Defined in src/worker/task-functions.ts:51
    • @@ -69,7 +69,7 @@
  • error
  • status
    • -
    @@ -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
    • @@ -48,7 +48,7 @@
    +
  • Defined in src/pools/worker.ts:86

    • executing

    executing: number
    @@ -56,7 +56,7 @@
    +
  • Defined in src/pools/worker.ts:90

    • failed

    failed: number
    @@ -64,7 +64,7 @@
    +
  • Defined in src/pools/worker.ts:106

    • Optional Readonly maxQueued

    maxQueued?: number
    @@ -72,7 +72,7 @@
    +
  • Defined in src/pools/worker.ts:98

    • Readonly queued

    queued: number
    @@ -80,7 +80,7 @@
    +
  • Defined in src/pools/worker.ts:94

    • stolen

    stolen: number
    @@ -88,7 +88,7 @@
    +
  • Defined in src/pools/worker.ts:102
    • @@ -115,7 +115,7 @@
  • queued
  • stolen
    • -
    @@ -24,7 +24,7 @@
    • TaskStatisticsRequirements
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:132
    • @@ -45,7 +45,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:144

    • Readonly runTime

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

    • Readonly waitTime

    waitTime: MeasurementStatisticsRequirements
    @@ -61,7 +61,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:140
    • @@ -85,7 +85,7 @@
  • runTime
  • waitTime
    • -
    @@ -24,7 +24,7 @@
    • TasksQueueOptions
    +
  • Defined in src/pools/pool.ts:99
    • @@ -49,7 +49,7 @@
    +
  • Defined in src/pools/pool.ts:111

    • Optional Readonly size

    size?: number
    @@ -60,29 +60,29 @@
    +
  • Defined in src/pools/pool.ts:105

    • Optional Readonly taskStealing

    taskStealing?: boolean
    -

    Whether to enable task stealing.

    +

    Whether to enable task stealing on empty queue.

    Default Value

    true
    +
  • Defined in src/pools/pool.ts:117

    • Optional Readonly tasksStealingOnBackPressure

    tasksStealingOnBackPressure?: boolean
    -

    Whether to enable tasks stealing on back pressure.

    +

    Whether to enable tasks stealing under back pressure.

    Default Value

    true
    +
  • Defined in src/pools/pool.ts:123
    • @@ -107,7 +107,7 @@
  • taskStealing
  • tasksStealingOnBackPressure
    • -
    @@ -26,7 +26,7 @@
    • ThreadPoolOptions
    +
  • Defined in src/pools/thread/fixed.ts:18
    • @@ -60,7 +60,7 @@
    +
  • Defined in src/pools/pool.ts:181

    • Optional enableTasksQueue

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

    • Optional errorHandler

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

    • Optional exitHandler

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

    • Optional messageHandler

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

    • Optional onlineHandler

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

    • Optional restartWorkerOnError

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

    • Optional startWorkers

    startWorkers?: boolean
    @@ -137,7 +137,7 @@
    +
  • Defined in src/pools/pool.ts:161

    • Optional tasksQueueOptions

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

    • Optional workerChoiceStrategy

    workerChoiceStrategy?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
    @@ -158,7 +158,7 @@
    +
  • Defined in src/pools/pool.ts:167

    • Optional workerChoiceStrategyOptions

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

    • Optional workerOptions

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

    See

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

    +
  • Defined in src/pools/thread/fixed.ts:24
    • @@ -210,7 +210,7 @@
  • workerChoiceStrategyOptions
  • workerOptions
    • -
    @@ -24,7 +24,7 @@
    • WorkerChoiceStrategyOptions
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:69
    • @@ -51,7 +51,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:97

    • Optional Readonly measurement

    measurement?: "runTime" | "waitTime" | "elu"
    @@ -59,7 +59,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:79

    • Optional Readonly retries

    retries?: number
    @@ -70,7 +70,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:75

    • Optional Readonly runTime

    runTime?: MeasurementOptions
    @@ -81,7 +81,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:85

    • Optional Readonly waitTime

    waitTime?: MeasurementOptions
    @@ -92,7 +92,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:91

    • Optional Readonly weights

    weights?: Record<number, number>
    @@ -104,7 +104,7 @@ A weight is tasks maximum execution time in milliseconds for a worker node.

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:104
    • @@ -131,7 +131,7 @@ A weight is tasks maximum execution time in milliseconds for a worker node.

  • waitTime
  • weights
    • -
    @@ -32,7 +32,7 @@
    • WorkerError
    +
  • 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 @@
    • WorkerInfo
    +
  • Defined in src/pools/worker.ts:127
    • @@ -47,7 +47,7 @@
    +
  • Defined in src/pools/worker.ts:139

    • Readonly id

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

    • ready

    ready: boolean
    @@ -63,7 +63,7 @@
    +
  • Defined in src/pools/worker.ts:143

    • Optional taskFunctionNames

    taskFunctionNames?: string[]
    @@ -71,7 +71,7 @@
    +
  • Defined in src/pools/worker.ts:147

    • Readonly type

    type: "thread" | "cluster"
    @@ -79,7 +79,7 @@
    +
  • Defined in src/pools/worker.ts:135
    • @@ -105,7 +105,7 @@
  • taskFunctionNames
  • type
    • -
    @@ -24,7 +24,7 @@
    • WorkerOptions
    +
  • Defined in src/worker/worker-options.ts:28
    • @@ -51,7 +51,7 @@

    Deprecated

    This option will be removed in the next major version.

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

    • Optional killBehavior

    killBehavior?: "SOFT" | "HARD"
    @@ -67,7 +67,7 @@
    +
  • Defined in src/worker/worker-options.ts:39

    • Optional killHandler

    killHandler?: KillHandler
    @@ -77,7 +77,7 @@

    Default Value

    () => {}

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

    • Optional maxInactiveTime

    maxInactiveTime?: number
    @@ -95,7 +95,7 @@ when this timeout expires your tasks is interrupted before completion and remove
    +
  • Defined in src/worker/worker-options.ts:52
    • @@ -120,7 +120,7 @@ when this timeout expires your tasks is interrupted before completion and remove
  • killHandler
  • maxInactiveTime
    • -
    @@ -24,7 +24,7 @@
    • WorkerStatistics
    +
  • Defined in src/utility-types.ts:54
    • @@ -44,7 +44,7 @@
    +
  • Defined in src/utility-types.ts:62

    • Readonly runTime

    runTime: boolean
    @@ -52,7 +52,7 @@
    +
  • Defined in src/utility-types.ts:58
    • @@ -75,7 +75,7 @@
  • elu
  • runTime
    • -
    @@ -24,7 +24,7 @@
    • WorkerUsage
    +
  • Defined in src/pools/worker.ts:155
    • @@ -46,7 +46,7 @@
    +
  • Defined in src/pools/worker.ts:171

    • Readonly runTime

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

    • Readonly tasks

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

    • Readonly waitTime

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

    Returns void

    +
  • Defined in src/pools/worker.ts:21
    • @@ -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

    -
    @@ -28,7 +28,7 @@

    Returns void | Promise<void>

    +
  • Defined in src/worker/worker-options.ts:23
    • @@ -45,7 +45,7 @@

    Theme

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

    Theme

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

    Returns void

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

    Theme

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

    Returns void

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

    Theme

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

    Theme

    -
    @@ -20,7 +20,7 @@
    +
  • Defined in src/pools/pool.ts:35
    • @@ -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:40
    • @@ -37,7 +37,7 @@

    Theme

    -
    @@ -36,7 +36,7 @@

    Returns void

    +
  • Defined in src/pools/worker.ts:217
    • @@ -53,7 +53,7 @@

    Theme

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

    Theme

    -
    @@ -22,7 +22,7 @@

  • T

    • +
  • Defined in src/utility-types.ts:181
    • @@ -39,7 +39,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:45
    • @@ -46,7 +46,7 @@

    Theme

    -
    @@ -37,7 +37,7 @@
    Readonly taskError: "taskError"
    +
  • Defined in src/pools/pool.ts:40
    • @@ -54,7 +54,7 @@

    Theme

    -
    @@ -33,7 +33,7 @@
    +
  • Defined in src/pools/pool.ts:21
    • @@ -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:112
    • @@ -44,7 +44,7 @@

    Theme

    -