From d93988cdbc3eb55747301602bfa03d8543223c71 Mon Sep 17 00:00:00 2001 From: Documentation Bot Date: Mon, 25 Sep 2023 16:30:55 +0000 Subject: [PATCH] docs: generate documentation --- docs/classes/AbstractPool.html | 200 +++++++++--------- docs/classes/AbstractWorker.html | 90 ++++---- docs/classes/CircularArray.html | 28 +-- docs/classes/ClusterWorker.html | 68 +++--- docs/classes/Deque.html | 38 ++-- docs/classes/DynamicClusterPool.html | 108 +++++----- docs/classes/DynamicThreadPool.html | 108 +++++----- docs/classes/FixedClusterPool.html | 108 +++++----- docs/classes/FixedThreadPool.html | 108 +++++----- docs/classes/Node.html | 16 +- docs/classes/ThreadWorker.html | 70 +++--- docs/classes/WorkerChoiceStrategyContext.html | 32 +-- docs/functions/availableParallelism.html | 8 +- docs/index.html | 8 +- docs/interfaces/ClusterPoolOptions.html | 34 +-- ...tLoopUtilizationMeasurementStatistics.html | 14 +- docs/interfaces/IPool.html | 40 ++-- docs/interfaces/IWorker.html | 16 +- docs/interfaces/IWorkerChoiceStrategy.html | 22 +- docs/interfaces/IWorkerNode.html | 46 ++-- docs/interfaces/MeasurementOptions.html | 10 +- docs/interfaces/MeasurementStatistics.html | 20 +- .../MeasurementStatisticsRequirements.html | 14 +- docs/interfaces/MessageValue.html | 44 ++-- docs/interfaces/PoolInfo.html | 50 ++--- docs/interfaces/PoolOptions.html | 30 +-- docs/interfaces/PromiseResponseWrapper.html | 14 +- docs/interfaces/StrategyData.html | 10 +- docs/interfaces/StrategyPolicy.html | 12 +- docs/interfaces/Task.html | 20 +- .../TaskFunctionOperationResult.html | 12 +- docs/interfaces/TaskPerformance.html | 16 +- docs/interfaces/TaskStatistics.html | 20 +- .../TaskStatisticsRequirements.html | 14 +- docs/interfaces/TasksQueueOptions.html | 16 +- docs/interfaces/ThreadPoolOptions.html | 32 +-- .../WorkerChoiceStrategyOptions.html | 20 +- docs/interfaces/WorkerError.html | 14 +- docs/interfaces/WorkerInfo.html | 18 +- docs/interfaces/WorkerOptions.html | 16 +- docs/interfaces/WorkerStatistics.html | 12 +- docs/interfaces/WorkerUsage.html | 16 +- docs/types/ErrorHandler.html | 8 +- docs/types/ExitHandler.html | 8 +- docs/types/KillBehavior.html | 8 +- docs/types/KillHandler.html | 8 +- docs/types/Measurement.html | 8 +- docs/types/MessageHandler.html | 8 +- docs/types/OnlineHandler.html | 8 +- docs/types/PoolEvent.html | 8 +- docs/types/PoolType.html | 8 +- docs/types/TaskAsyncFunction.html | 8 +- docs/types/TaskFunction.html | 8 +- docs/types/TaskFunctions.html | 8 +- docs/types/TaskSyncFunction.html | 8 +- docs/types/WorkerChoiceStrategy.html | 8 +- docs/types/WorkerNodeEventCallback.html | 8 +- docs/types/WorkerType.html | 8 +- docs/types/Writable.html | 8 +- docs/variables/KillBehaviors.html | 8 +- docs/variables/Measurements.html | 8 +- docs/variables/PoolEvents.html | 8 +- docs/variables/PoolTypes.html | 8 +- docs/variables/WorkerChoiceStrategies.html | 8 +- docs/variables/WorkerTypes.html | 8 +- 65 files changed, 888 insertions(+), 888 deletions(-) diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 5e927890..57019215 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,4 +1,4 @@ -AbstractPool | poolifier - v2.7.3
+AbstractPool | poolifier - v2.7.4
  • Preparing search index...
  • -
  • The search index is not available
poolifier - v2.7.3
+
  • The search index is not available
  • poolifier - v2.7.4
    @@ -49,7 +49,7 @@
    • IPool<Worker, Data, Response>
    +
  • Defined in src/pools/abstract-pool.ts:64
  • @@ -202,7 +202,7 @@

    Returns AbstractPool<Worker, Data, Response>

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

    @@ -224,7 +224,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:73
  • filePath: string
    @@ -232,7 +232,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:128
  • max?: number
    @@ -240,7 +240,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:97
  • numberOfWorkers: number
    @@ -248,7 +248,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:127
  • opts: PoolOptions<Worker>
    @@ -256,7 +256,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:129
  • 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
  • startTimestamp: number
    @@ -277,7 +277,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:117
  • started: boolean
    @@ -285,7 +285,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:109
  • starting: boolean
    @@ -293,7 +293,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:113
  • 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
  • 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
  • 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
  • +
  • Defined in src/pools/abstract-pool.ts:651
  • +
  • Defined in src/pools/abstract-pool.ts:271
  • +
  • Defined in src/pools/abstract-pool.ts:484
  • +
  • Defined in src/pools/abstract-pool.ts:477
  • +
  • Defined in src/pools/abstract-pool.ts:429
    • @@ -405,7 +405,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo

      Returns "fixed" | "dynamic"

    +
  • Defined in src/pools/abstract-pool.ts:467
  • +
  • Defined in src/pools/abstract-pool.ts:446
    • @@ -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
  • +
  • Defined in src/pools/abstract-pool.ts:1596
  • +
  • Defined in src/pools/abstract-pool.ts:1035
  • +
  • Defined in src/pools/abstract-pool.ts:1346
  • +
  • Defined in src/pools/abstract-pool.ts:1005
  • Returns TasksQueueOptions

    +
  • Defined in src/pools/abstract-pool.ts:600
  • +
  • Defined in src/pools/abstract-pool.ts:1571
  • +
  • Defined in src/pools/abstract-pool.ts:1559
  • +
  • Defined in src/pools/abstract-pool.ts:1565
  • +
  • Defined in src/pools/abstract-pool.ts:494
    • @@ -624,7 +624,7 @@ Can be overridden.

      numberOfWorkers: number

    Returns void

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

      opts: PoolOptions<Worker>

    Returns void

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

    +
  • Defined in src/pools/abstract-pool.ts:217
  • +
  • Defined in src/pools/abstract-pool.ts:1162
  • +
  • Defined in src/pools/abstract-pool.ts:1252
  • +
  • Defined in src/pools/abstract-pool.ts:1208
  • +
  • Defined in src/pools/abstract-pool.ts:1201
    • @@ -712,7 +712,7 @@ Can be overridden.

      name: string

    Returns void

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

      workerNodeKey: number

    Returns undefined | Task<Data>

    +
  • Defined in src/pools/abstract-pool.ts:1661
  • +
  • Defined in src/pools/abstract-pool.ts:1333
  • +
  • Defined in src/pools/abstract-pool.ts:940
  • +
  • Defined in src/pools/abstract-pool.ts:981
  • +
  • Defined in src/pools/abstract-pool.ts:565
    • @@ -836,7 +836,7 @@ Can be overridden.

      task: Task<Data>

    Returns number

    +
  • Defined in src/pools/abstract-pool.ts:1655
  • +
  • Defined in src/pools/abstract-pool.ts:870
  • +
  • Defined in src/pools/abstract-pool.ts:1649
    • @@ -904,7 +904,7 @@ Can be overridden.

      workerNodeKey: number

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1669
  • +
  • Defined in src/pools/abstract-pool.ts:1679
  • +
  • Defined in src/pools/abstract-pool.ts:1585
  • +
  • Defined in src/pools/abstract-pool.ts:513
  • +
  • Defined in src/pools/abstract-pool.ts:525
    • @@ -985,7 +985,7 @@ Can be overridden.

      message: MessageValue<Response, unknown>

    Returns void

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

      message: MessageValue<Response, unknown>

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1515
  • +
  • Defined in src/pools/abstract-pool.ts:1634
  • +
  • Defined in src/pools/abstract-pool.ts:783
  • +
  • Defined in src/pools/abstract-pool.ts:1627
  • +
  • Defined in src/pools/abstract-pool.ts:264
  • +
  • Defined in src/pools/abstract-pool.ts:667
  • +
  • Defined in src/pools/abstract-pool.ts:996
  • +
  • Defined in src/pools/abstract-pool.ts:835
    • @@ -1105,7 +1105,7 @@ Can be overridden.

      workerNodeKey: number

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1389
  • +
  • Defined in src/pools/abstract-pool.ts:1320
  • +
  • Defined in src/pools/abstract-pool.ts:1307
  • +
  • Defined in src/pools/abstract-pool.ts:819
  • +
  • Defined in src/pools/abstract-pool.ts:1618
    • @@ -1238,7 +1238,7 @@ Can be overridden.

      workerNodeKey: number

    Returns Promise<void>

    +
  • Defined in src/pools/abstract-pool.ts:953
  • +
  • Defined in src/pools/abstract-pool.ts:1370
  • +
  • Defined in src/pools/abstract-pool.ts:1377
    • @@ -1291,7 +1291,7 @@ Can be overridden.

      message: MessageValue<Data, unknown>

    Returns Promise<boolean>

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

      message: MessageValue<Data, unknown>

    Returns Promise<boolean>

    +
  • Defined in src/pools/abstract-pool.ts:727
  • +
  • Defined in src/pools/abstract-pool.ts:1190
  • +
  • Defined in src/pools/abstract-pool.ts:848
  • +
  • Defined in src/pools/abstract-pool.ts:620
  • +
  • Defined in src/pools/abstract-pool.ts:579
    • @@ -1395,7 +1395,7 @@ Can be overridden.

      size: number

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:614
  • +
  • Defined in src/pools/abstract-pool.ts:633
  • +
  • Defined in src/pools/abstract-pool.ts:532
  • +
  • Defined in src/pools/abstract-pool.ts:551
  • +
  • Defined in src/pools/abstract-pool.ts:989
  • +
  • Defined in src/pools/abstract-pool.ts:1179
    • @@ -1485,7 +1485,7 @@ Can be overridden.

      workerNodeKey: number

    Returns boolean

    +
  • Defined in src/pools/abstract-pool.ts:861
  • +
  • Defined in src/pools/abstract-pool.ts:1068
  • +
  • Defined in src/pools/abstract-pool.ts:924
    • @@ -1530,7 +1530,7 @@ Can be overridden.

      workerId: number

    Returns void

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

      workerNodeKey: number

    Returns number

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

      workerId: number

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1457
  • +
  • Defined in src/pools/abstract-pool.ts:627
  • +
  • Defined in src/pools/abstract-pool.ts:640
    • @@ -1587,7 +1587,7 @@ Can be overridden.

      message: MessageValue<Response, unknown>

    Returns void

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

      message: MessageValue<Response, unknown>

    Returns void

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

      message: MessageValue<Response, unknown>

    Returns void

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

      taskName: string

    Returns void

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

      task: Task<Data>

    Returns void

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

    +
  • Defined in src/pools/abstract-pool.ts:1497
  • @@ -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
  • id: number
    @@ -171,7 +171,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:63
  • isMain: boolean
    @@ -179,7 +179,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:91
  • lastTaskTimestamp: number
    @@ -187,7 +187,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:71
  • mainWorker: MainWorker
    @@ -195,7 +195,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:92
  • opts: WorkerOptions = DEFAULT_WORKER_OPTIONS
    @@ -203,7 +203,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:94
  • statistics: WorkerStatistics
    @@ -211,7 +211,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:75
  • 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
    • @@ -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.6.5/node_modules/@types/node/async_hooks.d.ts:315
    • @@ -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
    • @@ -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.6.5/node_modules/@types/node/async_hooks.d.ts:288
  • +
  • Defined in src/worker/abstract-worker.ts:439
  • +
  • Defined in src/worker/abstract-worker.ts:405
  • +
  • Defined in src/worker/abstract-worker.ts:611
  • +
  • Defined in src/worker/abstract-worker.ts:118
    • @@ -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
    • @@ -386,7 +386,7 @@ never be called.

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

    +
  • Defined in src/worker/abstract-worker.ts:596
  • +
  • Defined in src/worker/abstract-worker.ts:454
  • +
  • Defined in src/worker/abstract-worker.ts:485
  • +
  • Defined in src/worker/abstract-worker.ts:371
  • +
  • Defined in src/worker/abstract-worker.ts:299
    • @@ -484,7 +484,7 @@ never be called.

      message: MessageValue<Data, unknown>

    Returns void

    +
  • Defined in src/worker/abstract-worker.ts:326
  • +
  • Defined in src/worker/abstract-worker.ts:162
  • +
  • Defined in src/worker/abstract-worker.ts:243
  • +
  • Defined in src/worker/abstract-worker.ts:306
  • +
  • Defined in src/worker/abstract-worker.ts:214
  • +
  • Defined in src/worker/abstract-worker.ts:494
  • +
  • Defined in src/worker/abstract-worker.ts:555
    • @@ -653,7 +653,7 @@ then restore the original execution context.

    +
  • Defined in node_modules/.pnpm/@types+node@20.6.5/node_modules/@types/node/async_hooks.d.ts:299
  • +
  • Defined in src/worker/abstract-worker.ts:521
  • +
  • Defined in src/worker/abstract-worker.ts:473
  • +
  • Defined in src/worker/abstract-worker.ts:466
  • +
  • Defined in src/worker/abstract-worker.ts:270
  • +
  • Defined in src/worker/abstract-worker.ts:418
  • +
  • Defined in src/worker/abstract-worker.ts:429
    • @@ -760,7 +760,7 @@ then restore the original execution context.

    +
  • Defined in node_modules/.pnpm/@types+node@20.6.5/node_modules/@types/node/async_hooks.d.ts:319
  • +
  • Defined in src/worker/abstract-worker.ts:617
    • @@ -804,7 +804,7 @@ then restore the original execution context.

    +
  • Defined in node_modules/.pnpm/@types+node@20.6.5/node_modules/@types/node/async_hooks.d.ts:278
  • @@ -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: number
    +
  • Defined in src/circular-array.ts:11
  • [species]: ArrayConstructor

    Returns void

    +
  • Defined in src/circular-array.ts:100
    • @@ -222,7 +222,7 @@ when they will be absent when used in a 'with' statement.

      Inherit Doc

    +
  • Defined in src/circular-array.ts:41
  • +
  • Defined in src/circular-array.ts:92
    • @@ -729,7 +729,7 @@ thisArg is omitted, undefined is used as the this value.

    • Returns boolean

    +
  • Defined in src/circular-array.ts:96
    • @@ -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
    • @@ -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
    • @@ -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
    • @@ -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
    • @@ -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
  • isMain: boolean
    @@ -148,7 +148,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:91
  • lastTaskTimestamp: number
    @@ -157,7 +157,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:71
  • 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
  • statistics: WorkerStatistics
    @@ -175,7 +175,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:75
  • 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
    • @@ -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.6.5/node_modules/@types/node/async_hooks.d.ts:315
    • @@ -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.6.5/node_modules/@types/node/async_hooks.d.ts:288
    • @@ -281,7 +281,7 @@ never be called.

    +
  • Defined in node_modules/.pnpm/@types+node@20.6.5/node_modules/@types/node/async_hooks.d.ts:311
  • +
  • Defined in src/worker/abstract-worker.ts:454
  • +
  • Defined in src/worker/abstract-worker.ts:485
  • +
  • Defined in src/worker/abstract-worker.ts:371
  • +
  • Defined in src/worker/cluster-worker.ts:45
  • +
  • Defined in src/worker/abstract-worker.ts:326
  • +
  • Defined in src/worker/abstract-worker.ts:162
  • +
  • Defined in src/worker/abstract-worker.ts:243
  • +
  • Defined in src/worker/abstract-worker.ts:306
  • +
  • Defined in src/worker/abstract-worker.ts:214
  • +
  • Defined in src/worker/abstract-worker.ts:494
  • +
  • Defined in src/worker/abstract-worker.ts:555
    • @@ -546,7 +546,7 @@ then restore the original execution context.

    +
  • Defined in node_modules/.pnpm/@types+node@20.6.5/node_modules/@types/node/async_hooks.d.ts:299
  • +
  • Defined in src/worker/abstract-worker.ts:521
  • +
  • Defined in src/worker/abstract-worker.ts:473
  • +
  • Defined in src/worker/cluster-worker.ts:68
  • +
  • Defined in src/worker/abstract-worker.ts:270
    • @@ -635,7 +635,7 @@ then restore the original execution context.

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

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

    head?: Node<T>
    +
  • Defined in src/deque.ts:27
  • maxSize: number
    @@ -92,7 +92,7 @@ Implemented with a doubly linked list.

    +
  • Defined in src/deque.ts:32
  • size: number
    @@ -100,12 +100,12 @@ Implemented with a doubly linked list.

    +
  • Defined in src/deque.ts:30
  • 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
  • +
  • Defined in src/deque.ts:170
    • @@ -146,7 +146,7 @@ Implemented with a doubly linked list.

      Returns void

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

    • Returns number

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

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

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

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

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

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

    +
  • Defined in src/deque.ts:61
  • @@ -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,7 +156,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/cluster/dynamic.ts:28
  • Properties

    @@ -178,7 +178,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:73
  • filePath: string
    @@ -187,7 +187,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:128
  • max: number
    @@ -196,7 +196,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/cluster/dynamic.ts:30
  • numberOfWorkers: number
    @@ -205,7 +205,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:127
  • @@ -214,7 +214,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/cluster/fixed.ts:47
  • 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
  • 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
  • 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
    • @@ -274,7 +274,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:651
    • @@ -286,7 +286,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:271
    • @@ -298,7 +298,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:484
    • @@ -310,7 +310,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:477
    • @@ -322,7 +322,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:429
    • @@ -335,7 +335,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/cluster/dynamic.ts:39
    • @@ -348,7 +348,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:446
    • @@ -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
  • +
  • Defined in src/pools/abstract-pool.ts:1035
  • +
  • Defined in src/pools/abstract-pool.ts:1346
  • +
  • Defined in src/pools/abstract-pool.ts:1005
  • +
  • Defined in src/pools/abstract-pool.ts:1252
  • +
  • Defined in src/pools/abstract-pool.ts:1208
  • +
  • Defined in src/pools/cluster/fixed.ts:124
  • +
  • Defined in src/pools/cluster/fixed.ts:116
  • +
  • Defined in src/pools/abstract-pool.ts:940
  • +
  • Defined in src/pools/cluster/fixed.ts:63
  • +
  • Defined in src/pools/abstract-pool.ts:565
  • +
  • Defined in src/pools/abstract-pool.ts:870
  • +
  • Defined in src/pools/abstract-pool.ts:1669
  • +
  • Defined in src/pools/abstract-pool.ts:1585
  • +
  • Defined in src/pools/abstract-pool.ts:783
  • +
  • Defined in src/pools/abstract-pool.ts:1627
  • +
  • Defined in src/pools/abstract-pool.ts:667
  • +
  • Defined in src/pools/cluster/fixed.ts:58
  • +
  • Defined in src/pools/abstract-pool.ts:835
  • +
  • Defined in src/pools/cluster/fixed.ts:108
  • +
  • Defined in src/pools/cluster/fixed.ts:100
  • +
  • Defined in src/pools/abstract-pool.ts:819
  • +
  • Defined in src/pools/abstract-pool.ts:953
  • +
  • Defined in src/pools/cluster/fixed.ts:93
  • +
  • Defined in src/pools/cluster/fixed.ts:82
  • +
  • Defined in src/pools/abstract-pool.ts:848
  • +
  • Defined in src/pools/abstract-pool.ts:579
  • +
  • Defined in src/pools/abstract-pool.ts:532
  • +
  • Defined in src/pools/abstract-pool.ts:551
  • +
  • Defined in src/pools/cluster/fixed.ts:53
  • +
  • Defined in src/pools/abstract-pool.ts:924
  • +
  • Defined in src/pools/abstract-pool.ts:1497
  • @@ -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,7 +156,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/thread/dynamic.ts:28
  • Properties

    @@ -178,7 +178,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:73
  • filePath: string
    @@ -187,7 +187,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:128
  • max: number
    @@ -196,7 +196,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/thread/dynamic.ts:30
  • numberOfWorkers: number
    @@ -205,7 +205,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:127
  • @@ -214,7 +214,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/thread/fixed.ts:49
  • 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
  • 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
  • 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
    • @@ -274,7 +274,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:651
    • @@ -286,7 +286,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:271
    • @@ -298,7 +298,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:484
    • @@ -310,7 +310,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:477
    • @@ -322,7 +322,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:429
    • @@ -335,7 +335,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/thread/dynamic.ts:39
    • @@ -348,7 +348,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:446
    • @@ -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
  • +
  • Defined in src/pools/abstract-pool.ts:1035
  • +
  • Defined in src/pools/abstract-pool.ts:1346
  • +
  • Defined in src/pools/abstract-pool.ts:1005
  • +
  • Defined in src/pools/abstract-pool.ts:1252
  • +
  • Defined in src/pools/abstract-pool.ts:1208
  • +
  • Defined in src/pools/thread/fixed.ts:136
  • +
  • Defined in src/pools/thread/fixed.ts:126
  • +
  • Defined in src/pools/abstract-pool.ts:940
  • +
  • Defined in src/pools/thread/fixed.ts:60
  • +
  • Defined in src/pools/abstract-pool.ts:565
  • +
  • Defined in src/pools/abstract-pool.ts:870
  • +
  • Defined in src/pools/abstract-pool.ts:1669
  • +
  • Defined in src/pools/abstract-pool.ts:1585
  • +
  • Defined in src/pools/abstract-pool.ts:783
  • +
  • Defined in src/pools/abstract-pool.ts:1627
  • +
  • Defined in src/pools/abstract-pool.ts:667
  • +
  • Defined in src/pools/thread/fixed.ts:55
  • +
  • Defined in src/pools/abstract-pool.ts:835
  • +
  • Defined in src/pools/thread/fixed.ts:116
  • +
  • Defined in src/pools/thread/fixed.ts:106
  • +
  • Defined in src/pools/abstract-pool.ts:819
  • +
  • Defined in src/pools/abstract-pool.ts:953
  • +
  • Defined in src/pools/thread/fixed.ts:91
  • +
  • Defined in src/pools/thread/fixed.ts:77
  • +
  • Defined in src/pools/abstract-pool.ts:848
  • +
  • Defined in src/pools/abstract-pool.ts:579
  • +
  • Defined in src/pools/abstract-pool.ts:532
  • +
  • Defined in src/pools/abstract-pool.ts:551
  • +
  • Defined in src/pools/abstract-pool.ts:989
  • +
  • Defined in src/pools/abstract-pool.ts:924
  • +
  • Defined in src/pools/abstract-pool.ts:1497
  • @@ -45,7 +45,7 @@ +
  • Defined in src/pools/cluster/fixed.ts:33
  • @@ -151,7 +151,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:44
  • Properties

    @@ -173,7 +173,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:73
  • filePath: string
    @@ -182,7 +182,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:128
  • max?: number
    @@ -191,7 +191,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:97
  • numberOfWorkers: number
    @@ -200,7 +200,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:127
  • @@ -209,7 +209,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/cluster/fixed.ts:47
  • 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
  • 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
  • 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
    • @@ -269,7 +269,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:651
    • @@ -281,7 +281,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:271
    • @@ -293,7 +293,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:484
    • @@ -305,7 +305,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:477
    • @@ -317,7 +317,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:429
    • @@ -330,7 +330,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/cluster/fixed.ts:129
    • @@ -343,7 +343,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:446
    • @@ -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
  • +
  • Defined in src/pools/abstract-pool.ts:1035
  • +
  • Defined in src/pools/abstract-pool.ts:1346
  • +
  • Defined in src/pools/abstract-pool.ts:1005
  • +
  • Defined in src/pools/abstract-pool.ts:1252
  • +
  • Defined in src/pools/abstract-pool.ts:1208
  • +
  • Defined in src/pools/cluster/fixed.ts:124
  • +
  • Defined in src/pools/cluster/fixed.ts:116
  • +
  • Defined in src/pools/abstract-pool.ts:940
  • +
  • Defined in src/pools/cluster/fixed.ts:63
  • +
  • Defined in src/pools/abstract-pool.ts:565
  • +
  • Defined in src/pools/abstract-pool.ts:870
  • +
  • Defined in src/pools/abstract-pool.ts:1669
  • +
  • Defined in src/pools/abstract-pool.ts:1585
  • +
  • Defined in src/pools/abstract-pool.ts:783
  • +
  • Defined in src/pools/abstract-pool.ts:1627
  • +
  • Defined in src/pools/abstract-pool.ts:667
  • +
  • Defined in src/pools/cluster/fixed.ts:58
  • +
  • Defined in src/pools/abstract-pool.ts:835
  • +
  • Defined in src/pools/cluster/fixed.ts:108
  • +
  • Defined in src/pools/cluster/fixed.ts:100
  • +
  • Defined in src/pools/abstract-pool.ts:819
  • +
  • Defined in src/pools/abstract-pool.ts:953
  • +
  • Defined in src/pools/cluster/fixed.ts:93
  • +
  • Defined in src/pools/cluster/fixed.ts:82
  • +
  • Defined in src/pools/abstract-pool.ts:848
  • +
  • Defined in src/pools/abstract-pool.ts:579
  • +
  • Defined in src/pools/abstract-pool.ts:532
  • +
  • Defined in src/pools/abstract-pool.ts:551
  • +
  • Defined in src/pools/cluster/fixed.ts:53
  • +
  • Defined in src/pools/abstract-pool.ts:924
  • +
  • Defined in src/pools/abstract-pool.ts:1497
  • @@ -45,7 +45,7 @@ +
  • Defined in src/pools/thread/fixed.ts:35
  • @@ -151,7 +151,7 @@
    +
  • Defined in src/pools/thread/fixed.ts:46
  • Properties

    @@ -173,7 +173,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:73
  • filePath: string
    @@ -182,7 +182,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:128
  • max?: number
    @@ -191,7 +191,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:97
  • numberOfWorkers: number
    @@ -200,7 +200,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:127
  • @@ -209,7 +209,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/thread/fixed.ts:49
  • 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
  • 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
  • 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
    • @@ -269,7 +269,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:651
    • @@ -281,7 +281,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:271
    • @@ -293,7 +293,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:484
    • @@ -305,7 +305,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:477
    • @@ -317,7 +317,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:429
    • @@ -330,7 +330,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/thread/fixed.ts:144
    • @@ -343,7 +343,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:446
    • @@ -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
  • +
  • Defined in src/pools/abstract-pool.ts:1035
  • +
  • Defined in src/pools/abstract-pool.ts:1346
  • +
  • Defined in src/pools/abstract-pool.ts:1005
  • +
  • Defined in src/pools/abstract-pool.ts:1252
  • +
  • Defined in src/pools/abstract-pool.ts:1208
  • +
  • Defined in src/pools/thread/fixed.ts:136
  • +
  • Defined in src/pools/thread/fixed.ts:126
  • +
  • Defined in src/pools/abstract-pool.ts:940
  • +
  • Defined in src/pools/thread/fixed.ts:60
  • +
  • Defined in src/pools/abstract-pool.ts:565
  • +
  • Defined in src/pools/abstract-pool.ts:870
  • +
  • Defined in src/pools/abstract-pool.ts:1669
  • +
  • Defined in src/pools/abstract-pool.ts:1585
  • +
  • Defined in src/pools/abstract-pool.ts:783
  • +
  • Defined in src/pools/abstract-pool.ts:1627
  • +
  • Defined in src/pools/abstract-pool.ts:667
  • +
  • Defined in src/pools/thread/fixed.ts:55
  • +
  • Defined in src/pools/abstract-pool.ts:835
  • +
  • Defined in src/pools/thread/fixed.ts:116
  • +
  • Defined in src/pools/thread/fixed.ts:106
  • +
  • Defined in src/pools/abstract-pool.ts:819
  • +
  • Defined in src/pools/abstract-pool.ts:953
  • +
  • Defined in src/pools/thread/fixed.ts:91
  • +
  • Defined in src/pools/thread/fixed.ts:77
  • +
  • Defined in src/pools/abstract-pool.ts:848
  • +
  • Defined in src/pools/abstract-pool.ts:579
  • +
  • Defined in src/pools/abstract-pool.ts:532
  • +
  • Defined in src/pools/abstract-pool.ts:551
  • +
  • Defined in src/pools/abstract-pool.ts:989
  • +
  • Defined in src/pools/abstract-pool.ts:924
  • +
  • Defined in src/pools/abstract-pool.ts:1497
  • @@ -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: T
    +
  • Defined in src/deque.ts:10
  • next?: Node<T>
    +
  • Defined in src/deque.ts:11
  • prev?: Node<T>
    +
  • Defined in src/deque.ts:12
  • @@ -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
  • isMain: boolean
    @@ -149,7 +149,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:91
  • lastTaskTimestamp: number
    @@ -158,7 +158,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:71
  • 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
  • port: MessagePort
    @@ -175,7 +175,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/thread-worker.ts:33
  • statistics: WorkerStatistics
    @@ -184,7 +184,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:75
  • 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
    • @@ -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.6.5/node_modules/@types/node/async_hooks.d.ts:315
    • @@ -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.6.5/node_modules/@types/node/async_hooks.d.ts:288
    • @@ -290,7 +290,7 @@ never be called.

    +
  • Defined in node_modules/.pnpm/@types+node@20.6.5/node_modules/@types/node/async_hooks.d.ts:311
  • +
  • Defined in src/worker/abstract-worker.ts:454
  • +
  • Defined in src/worker/thread-worker.ts:94
  • +
  • Defined in src/worker/thread-worker.ts:77
  • +
  • Defined in src/worker/thread-worker.ts:54
  • +
  • Defined in src/worker/abstract-worker.ts:326
  • +
  • Defined in src/worker/abstract-worker.ts:162
  • +
  • Defined in src/worker/abstract-worker.ts:243
  • +
  • Defined in src/worker/abstract-worker.ts:306
  • +
  • Defined in src/worker/abstract-worker.ts:214
  • +
  • Defined in src/worker/abstract-worker.ts:494
  • +
  • Defined in src/worker/abstract-worker.ts:555
    • @@ -555,7 +555,7 @@ then restore the original execution context.

    +
  • Defined in node_modules/.pnpm/@types+node@20.6.5/node_modules/@types/node/async_hooks.d.ts:299
  • +
  • Defined in src/worker/abstract-worker.ts:521
  • +
  • Defined in src/worker/abstract-worker.ts:473
  • +
  • Defined in src/worker/thread-worker.ts:89
  • +
  • Defined in src/worker/abstract-worker.ts:270
    • @@ -644,7 +644,7 @@ then restore the original execution context.

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

    +
  • Defined in node_modules/.pnpm/@types+node@20.6.5/node_modules/@types/node/async_hooks.d.ts:278
  • +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:40
  • 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
  • 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
  • +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:119
  • +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:132
  • +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:200
  • +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:213
  • +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:145
  • +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:159
  • @@ -26,7 +26,7 @@ Always returns a value greater than zero.

    +
  • Defined in src/utils.ts:51
  • -

    poolifier - v2.7.3

    +

    poolifier - v2.7.4

    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
  • enableTasksQueue?: boolean
    @@ -73,7 +73,7 @@
    +
  • Defined in src/pools/pool.ts:187
  • 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
  • errorHandler?: ErrorHandler<Worker>
    @@ -94,7 +94,7 @@
    +
  • Defined in src/pools/pool.ts:149
  • exitHandler?: ExitHandler<Worker>
    @@ -105,7 +105,7 @@
    +
  • Defined in src/pools/pool.ts:155
  • messageHandler?: MessageHandler<Worker>
    @@ -116,7 +116,7 @@
    +
  • Defined in src/pools/pool.ts:143
  • onlineHandler?: OnlineHandler<Worker>
    @@ -127,7 +127,7 @@
    +
  • Defined in src/pools/pool.ts:137
  • restartWorkerOnError?: boolean
    @@ -136,7 +136,7 @@
    +
  • Defined in src/pools/pool.ts:175
  • settings?: ClusterSettings
    @@ -146,7 +146,7 @@

    See

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

    +
  • Defined in src/pools/cluster/fixed.ts:22
  • startWorkers?: boolean
    @@ -158,7 +158,7 @@
    +
  • Defined in src/pools/pool.ts:161
  • tasksQueueOptions?: TasksQueueOptions
    @@ -167,7 +167,7 @@
    +
  • Defined in src/pools/pool.ts:191
  • 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
  • workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    @@ -188,7 +188,7 @@
    +
  • Defined in src/pools/pool.ts:171
  • @@ -24,7 +24,7 @@
    • EventLoopUtilizationMeasurementStatistics
    +
  • Defined in src/pools/worker.ts:71
  • @@ -42,17 +42,17 @@
    +
  • Defined in src/pools/worker.ts:73
  • +
  • Defined in src/pools/worker.ts:72
  • utilization?: number
    +
  • Defined in src/pools/worker.ts:74
  • @@ -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
  • destroy: (() => Promise<void>)
    @@ -123,7 +123,7 @@ If a task function with the same name already exists, it will be overwritten.

    Returns Promise<void>
    +
  • Defined in src/pools/pool.ts:259
  • emitter?: __module | EventEmitterAsyncResource
    @@ -142,7 +142,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/pool.ts:238
  • 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
  • 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
  • hasTaskFunction: ((name) => boolean)
    @@ -231,7 +231,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/pool.ts:266
  • hasWorkerNodeBackPressure: ((workerNodeKey) => boolean)
    @@ -256,7 +256,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/pool.ts:223
  • info: PoolInfo
    @@ -264,7 +264,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/pool.ts:209
  • listTaskFunctionNames: (() => string[])
    @@ -281,7 +281,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/pool.ts:293
  • removeTaskFunction: ((name) => Promise<boolean>)
    @@ -306,7 +306,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/pool.ts:287
  • setDefaultTaskFunction: ((name) => Promise<boolean>)
    @@ -331,7 +331,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/pool.ts:300
  • 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
  • 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
  • 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
  • start: (() => void)
    @@ -424,7 +424,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo

    Returns void

    +
  • Defined in src/pools/pool.ts:255
  • workerNodes: IWorkerNode<Worker, Data>[]
    @@ -432,7 +432,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/pool.ts:215
  • @@ -24,7 +24,7 @@
    • IWorker
    +
  • Defined in src/pools/worker.ts:186
  • @@ -46,7 +46,7 @@
    +
  • Defined in src/pools/worker.ts:190
  • 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
  • once: ((event, handler) => void)
    @@ -147,12 +147,12 @@

    Returns void

    +
  • Defined in src/pools/worker.ts:208
  • threadId?: number
    +
  • Defined in src/pools/worker.ts:191
  • @@ -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
  • 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
  • reset: (() => boolean)
    @@ -102,7 +102,7 @@ If undefined is returned, the caller retry.

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:182
  • 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
  • strategyPolicy: StrategyPolicy
    @@ -134,7 +134,7 @@ If undefined is returned, the caller retry.

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:172
  • taskStatisticsRequirements: TaskStatisticsRequirements
    @@ -142,7 +142,7 @@ If undefined is returned, the caller retry.

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:176
  • 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
  • @@ -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
  • closeChannel: (() => void)
    @@ -98,7 +98,7 @@

    Returns void

    +
  • Defined in src/pools/worker.ts:310
  • deleteTaskFunctionWorkerUsage: ((name) => boolean)
    @@ -123,7 +123,7 @@
    +
  • Defined in src/pools/worker.ts:324
  • dequeueTask: (() => undefined | Task<Data>)
    @@ -140,7 +140,7 @@
    +
  • Defined in src/pools/worker.ts:286
  • enqueueTask: ((task) => number)
    @@ -165,7 +165,7 @@
    +
  • Defined in src/pools/worker.ts:273
  • getTaskFunctionWorkerUsage: ((name) => undefined | WorkerUsage)
    @@ -190,7 +190,7 @@
    +
  • Defined in src/pools/worker.ts:317
  • hasBackPressure: (() => boolean)
    @@ -207,7 +207,7 @@
    +
  • Defined in src/pools/worker.ts:302
  • @@ -215,7 +215,7 @@
    +
  • Defined in src/pools/worker.ts:234
  • messageChannel?: MessageChannel
    @@ -223,7 +223,7 @@
    +
  • Defined in src/pools/worker.ts:247
  • onBackPressure?: WorkerNodeEventCallback
    @@ -231,7 +231,7 @@
    +
  • Defined in src/pools/worker.ts:256
  • @@ -239,7 +239,7 @@
    +
  • Defined in src/pools/worker.ts:260
  • popTask: (() => undefined | Task<Data>)
    @@ -256,7 +256,7 @@
    +
  • Defined in src/pools/worker.ts:292
  • resetUsage: (() => void)
    @@ -272,7 +272,7 @@

    Returns void

    +
  • Defined in src/pools/worker.ts:306
  • 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: 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
  • 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
  • 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
  • @@ -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
  • 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
  • +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:63
  • @@ -24,7 +24,7 @@
    • MeasurementStatistics
    +
  • Defined in src/pools/worker.ts:39
  • @@ -48,7 +48,7 @@
    +
  • Defined in src/pools/worker.ts:43
  • average?: number
    @@ -56,7 +56,7 @@
    +
  • Defined in src/pools/worker.ts:55
  • history: CircularArray<number>
    @@ -64,7 +64,7 @@
    +
  • Defined in src/pools/worker.ts:63
  • maximum?: number
    @@ -72,7 +72,7 @@
    +
  • Defined in src/pools/worker.ts:51
  • median?: number
    @@ -80,7 +80,7 @@
    +
  • Defined in src/pools/worker.ts:59
  • minimum?: number
    @@ -88,7 +88,7 @@
    +
  • Defined in src/pools/worker.ts:47
  • +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:120
  • median: boolean
    @@ -61,7 +61,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:124
  • @@ -39,7 +39,7 @@
    • MessageValue
    +
  • Defined in src/utility-types.ts:105
  • @@ -75,7 +75,7 @@
    +
  • Defined in src/utility-types.ts:153
  • data?: Data
    @@ -84,7 +84,7 @@
    +
  • Defined in src/utility-types.ts:83
  • kill?: true | "success" | "SOFT" | "HARD" | "failure"
    @@ -92,7 +92,7 @@
    +
  • Defined in src/utility-types.ts:110
  • name?: string
    @@ -101,7 +101,7 @@
    +
  • Defined in src/utility-types.ts:79
  • port?: MessagePort
    @@ -109,7 +109,7 @@
    +
  • Defined in src/utility-types.ts:157
  • ready?: boolean
    @@ -117,7 +117,7 @@
    +
  • Defined in src/utility-types.ts:149
  • statistics?: WorkerStatistics
    @@ -125,7 +125,7 @@
    +
  • Defined in src/utility-types.ts:145
  • taskFunction?: string
    @@ -133,7 +133,7 @@
    +
  • Defined in src/utility-types.ts:133
  • taskFunctionName?: string
    @@ -141,7 +141,7 @@
    +
  • Defined in src/utility-types.ts:137
  • taskFunctionNames?: string[]
    @@ -149,7 +149,7 @@
    +
  • Defined in src/utility-types.ts:141
  • taskFunctionOperation?: "add" | "default" | "remove"
    @@ -162,7 +162,7 @@
    +
  • Defined in src/utility-types.ts:125
  • taskFunctionOperationStatus?: boolean
    @@ -170,7 +170,7 @@
    +
  • Defined in src/utility-types.ts:129
  • taskId?: string
    @@ -179,7 +179,7 @@
    +
  • Defined in src/utility-types.ts:95
  • taskPerformance?: TaskPerformance
    @@ -187,7 +187,7 @@
    +
  • Defined in src/utility-types.ts:118
  • timestamp?: number
    @@ -196,7 +196,7 @@
    +
  • Defined in src/utility-types.ts:91
  • transferList?: TransferListItem[]
    @@ -205,7 +205,7 @@
    +
  • Defined in src/utility-types.ts:87
  • workerError?: WorkerError<ErrorData>
    @@ -213,7 +213,7 @@
    +
  • Defined in src/utility-types.ts:114
  • workerId?: number
    @@ -222,7 +222,7 @@
    +
  • Defined in src/utility-types.ts:75
  • @@ -24,7 +24,7 @@
    • PoolInfo
    +
  • Defined in src/pools/pool.ts:58
  • @@ -60,7 +60,7 @@
    backPressure?: boolean
    +
  • Defined in src/pools/pool.ts:79
  • busyWorkerNodes: number
    @@ -68,22 +68,22 @@
    +
  • Defined in src/pools/pool.ts:74
  • executedTasks: number
    +
  • Defined in src/pools/pool.ts:75
  • executingTasks: number
    +
  • Defined in src/pools/pool.ts:76
  • failedTasks: number
    +
  • Defined in src/pools/pool.ts:81
  • idleWorkerNodes: number
    @@ -91,32 +91,32 @@
    +
  • Defined in src/pools/pool.ts:72
  • maxQueuedTasks?: number
    +
  • Defined in src/pools/pool.ts:78
  • maxSize: number
    +
  • Defined in src/pools/pool.ts:66
  • minSize: number
    +
  • Defined in src/pools/pool.ts:65
  • queuedTasks?: number
    +
  • Defined in src/pools/pool.ts:77
  • ready: boolean
    +
  • Defined in src/pools/pool.ts:63
  • runTime?: {
        average?: number;
        maximum: number;
        median?: number;
        minimum: number;
    }
    @@ -132,27 +132,27 @@
  • Readonly minimum: number
  • +
  • Defined in src/pools/pool.ts:82
  • started: boolean
    +
  • Defined in src/pools/pool.ts:62
  • stolenTasks?: number
    +
  • Defined in src/pools/pool.ts:80
  • 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
  • type: "fixed" | "dynamic"
    +
  • Defined in src/pools/pool.ts:60
  • utilization?: number
    @@ -160,12 +160,12 @@
    +
  • Defined in src/pools/pool.ts:68
  • version: string
    +
  • Defined in src/pools/pool.ts:59
  • waitTime?: {
        average?: number;
        maximum: number;
        median?: number;
        minimum: number;
    }
    @@ -181,12 +181,12 @@
  • Readonly minimum: number
  • +
  • Defined in src/pools/pool.ts:88
  • worker: "thread" | "cluster"
    +
  • Defined in src/pools/pool.ts:61
  • workerNodes: number
    @@ -194,7 +194,7 @@
    +
  • Defined in src/pools/pool.ts:70
  • @@ -35,7 +35,7 @@
  • ClusterPoolOptions
  • ThreadPoolOptions
  • +
  • Defined in src/pools/pool.ts:131
  • @@ -67,7 +67,7 @@
    +
  • Defined in src/pools/pool.ts:181
  • enableTasksQueue?: boolean
    @@ -78,7 +78,7 @@
    +
  • Defined in src/pools/pool.ts:187
  • errorHandler?: ErrorHandler<Worker>
    @@ -88,7 +88,7 @@

    Default Value

    () => {}

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

    Default Value

    () => {}

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

    Default Value

    () => {}

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

    Default Value

    () => {}

    +
  • Defined in src/pools/pool.ts:137
  • restartWorkerOnError?: boolean
    @@ -126,7 +126,7 @@
    +
  • Defined in src/pools/pool.ts:175
  • startWorkers?: boolean
    @@ -137,7 +137,7 @@
    +
  • Defined in src/pools/pool.ts:161
  • tasksQueueOptions?: TasksQueueOptions
    @@ -145,7 +145,7 @@
    +
  • Defined in src/pools/pool.ts:191
  • 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
  • workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    @@ -164,7 +164,7 @@
    +
  • Defined in src/pools/pool.ts:171
  • @@ -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
  • resolve: ((value) => void)
    @@ -87,7 +87,7 @@

    Returns void

    +
  • Defined in src/utility-types.ts:170
  • workerNodeKey: number
    @@ -95,7 +95,7 @@
    +
  • Defined in src/utility-types.ts:178
  • @@ -24,7 +24,7 @@
    • StrategyData
    +
  • Defined in src/pools/worker.ts:179
  • @@ -40,7 +40,7 @@
    virtualTaskEndTimestamp?: number
    +
  • Defined in src/pools/worker.ts:180
  • +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:160
  • dynamicWorkerUsage: boolean
    @@ -52,7 +52,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:156
  • @@ -34,7 +34,7 @@ +
  • Defined in src/utility-types.ts:71
  • @@ -58,7 +58,7 @@
    +
  • Defined in src/utility-types.ts:83
  • name?: string
    @@ -66,7 +66,7 @@
    +
  • Defined in src/utility-types.ts:79
  • taskId?: string
    @@ -74,7 +74,7 @@
    +
  • Defined in src/utility-types.ts:95
  • timestamp?: number
    @@ -82,7 +82,7 @@
    +
  • Defined in src/utility-types.ts:91
  • transferList?: TransferListItem[]
    @@ -90,7 +90,7 @@
    +
  • Defined in src/utility-types.ts:87
  • workerId?: number
    @@ -98,7 +98,7 @@
    +
  • Defined in src/utility-types.ts:75
  • @@ -24,7 +24,7 @@
    • TaskFunctionOperationResult
    +
  • Defined in src/worker/task-functions.ts:50
  • @@ -41,12 +41,12 @@
    error?: Error
    +
  • Defined in src/worker/task-functions.ts:52
  • status: boolean
    +
  • Defined in src/worker/task-functions.ts:51
  • @@ -24,7 +24,7 @@
    • TaskPerformance
    +
  • Defined in src/utility-types.ts:30
  • @@ -46,7 +46,7 @@
    +
  • Defined in src/utility-types.ts:46
  • name: string
    @@ -54,7 +54,7 @@
    +
  • Defined in src/utility-types.ts:34
  • runTime?: number
    @@ -62,7 +62,7 @@
    +
  • Defined in src/utility-types.ts:42
  • timestamp: number
    @@ -70,7 +70,7 @@
    +
  • Defined in src/utility-types.ts:38
  • @@ -24,7 +24,7 @@
    • TaskStatistics
    +
  • Defined in src/pools/worker.ts:82
  • @@ -48,7 +48,7 @@
    +
  • Defined in src/pools/worker.ts:86
  • executing: number
    @@ -56,7 +56,7 @@
    +
  • Defined in src/pools/worker.ts:90
  • failed: number
    @@ -64,7 +64,7 @@
    +
  • Defined in src/pools/worker.ts:106
  • maxQueued?: number
    @@ -72,7 +72,7 @@
    +
  • Defined in src/pools/worker.ts:98
  • queued: number
    @@ -80,7 +80,7 @@
    +
  • Defined in src/pools/worker.ts:94
  • stolen: number
    @@ -88,7 +88,7 @@
    +
  • Defined in src/pools/worker.ts:102
  • +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:136
  • @@ -61,7 +61,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:140
  • @@ -24,7 +24,7 @@
    • TasksQueueOptions
    +
  • Defined in src/pools/pool.ts:99
  • @@ -49,7 +49,7 @@
    +
  • Defined in src/pools/pool.ts:111
  • size?: number
    @@ -60,7 +60,7 @@
    +
  • Defined in src/pools/pool.ts:105
  • taskStealing?: boolean
    @@ -71,7 +71,7 @@
    +
  • Defined in src/pools/pool.ts:117
  • tasksStealingOnBackPressure?: boolean
    @@ -82,7 +82,7 @@
    +
  • Defined in src/pools/pool.ts:123
  • @@ -26,7 +26,7 @@
    • ThreadPoolOptions
    +
  • Defined in src/pools/thread/fixed.ts:18
  • @@ -60,7 +60,7 @@
    +
  • Defined in src/pools/pool.ts:181
  • enableTasksQueue?: boolean
    @@ -72,7 +72,7 @@
    +
  • Defined in src/pools/pool.ts:187
  • errorHandler?: ErrorHandler<Worker>
    @@ -83,7 +83,7 @@
    +
  • Defined in src/pools/pool.ts:149
  • exitHandler?: ExitHandler<Worker>
    @@ -94,7 +94,7 @@
    +
  • Defined in src/pools/pool.ts:155
  • messageHandler?: MessageHandler<Worker>
    @@ -105,7 +105,7 @@
    +
  • Defined in src/pools/pool.ts:143
  • onlineHandler?: OnlineHandler<Worker>
    @@ -116,7 +116,7 @@
    +
  • Defined in src/pools/pool.ts:137
  • restartWorkerOnError?: boolean
    @@ -125,7 +125,7 @@
    +
  • Defined in src/pools/pool.ts:175
  • startWorkers?: boolean
    @@ -137,7 +137,7 @@
    +
  • Defined in src/pools/pool.ts:161
  • tasksQueueOptions?: TasksQueueOptions
    @@ -146,7 +146,7 @@
    +
  • Defined in src/pools/pool.ts:191
  • 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
  • workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    @@ -167,7 +167,7 @@
    +
  • Defined in src/pools/pool.ts:171
  • 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
  • @@ -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
  • measurement?: "runTime" | "waitTime" | "elu"
    @@ -59,7 +59,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:79
  • retries?: number
    @@ -70,7 +70,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:75
  • @@ -81,7 +81,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:85
  • @@ -92,7 +92,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:91
  • 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
  • @@ -32,7 +32,7 @@
    • WorkerError
    +
  • Defined in src/utility-types.ts:10
  • @@ -53,7 +53,7 @@
    +
  • Defined in src/utility-types.ts:22
  • message: string
    @@ -61,7 +61,7 @@
    +
  • Defined in src/utility-types.ts:18
  • name: string
    @@ -69,7 +69,7 @@
    +
  • Defined in src/utility-types.ts:14
  • @@ -24,7 +24,7 @@
    • WorkerInfo
    +
  • Defined in src/pools/worker.ts:127
  • @@ -47,7 +47,7 @@
    +
  • Defined in src/pools/worker.ts:139
  • id: undefined | number
    @@ -55,7 +55,7 @@
    +
  • Defined in src/pools/worker.ts:131
  • ready: boolean
    @@ -63,7 +63,7 @@
    +
  • Defined in src/pools/worker.ts:143
  • taskFunctionNames?: string[]
    @@ -71,7 +71,7 @@
    +
  • Defined in src/pools/worker.ts:147
  • type: "thread" | "cluster"
    @@ -79,7 +79,7 @@
    +
  • Defined in src/pools/worker.ts:135
  • @@ -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
  • killBehavior?: "SOFT" | "HARD"
    @@ -67,7 +67,7 @@
    +
  • Defined in src/worker/worker-options.ts:39
  • killHandler?: KillHandler
    @@ -77,7 +77,7 @@

    Default Value

    () => {}

    +
  • Defined in src/worker/worker-options.ts:58
  • 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
  • @@ -24,7 +24,7 @@
    • WorkerStatistics
    +
  • Defined in src/utility-types.ts:54
  • @@ -44,7 +44,7 @@
    +
  • Defined in src/utility-types.ts:62
  • runTime: boolean
    @@ -52,7 +52,7 @@
    +
  • Defined in src/utility-types.ts:58
  • @@ -24,7 +24,7 @@
    • WorkerUsage
    +
  • Defined in src/pools/worker.ts:155
  • @@ -46,7 +46,7 @@
    +
  • Defined in src/pools/worker.ts:171
  • @@ -54,7 +54,7 @@
    +
  • Defined in src/pools/worker.ts:163
  • @@ -62,7 +62,7 @@
    +
  • Defined in src/pools/worker.ts:159
  • @@ -70,7 +70,7 @@
    +
  • Defined in src/pools/worker.ts:167
  • @@ -40,7 +40,7 @@

    Returns void

    +
  • Defined in src/pools/worker.ts:21
  • @@ -40,7 +40,7 @@

    Returns void

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

    Returns void | Promise<void>

    +
  • Defined in src/worker/worker-options.ts:23
  • +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:54
  • @@ -40,7 +40,7 @@

    Returns void

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

    Returns void

    +
  • Defined in src/pools/worker.ts:8
  • @@ -20,7 +20,7 @@
    +
  • Defined in src/pools/pool.ts:53
  • @@ -20,7 +20,7 @@
    +
  • Defined in src/pools/pool.ts:35
  • @@ -47,7 +47,7 @@ This function must return a promise.

    Returns Promise<Response>

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

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

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

    Returns Response

    +
  • Defined in src/worker/task-functions.ts:7
  • +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:40
  • @@ -36,7 +36,7 @@

    Returns void

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

  • +
  • Defined in src/utility-types.ts:181
  • @@ -33,7 +33,7 @@
    +
  • Defined in src/worker/worker-options.ts:4
  • @@ -29,7 +29,7 @@
    Readonly waitTime: "waitTime"
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:45
  • @@ -37,7 +37,7 @@
    Readonly taskError: "taskError"
    +
  • Defined in src/pools/pool.ts:40
  • @@ -33,7 +33,7 @@
    +
  • Defined in src/pools/pool.ts:21
  • +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:4
  • @@ -27,7 +27,7 @@
    Readonly thread: "thread"
    +
  • Defined in src/pools/worker.ts:112