From: Documentation Bot Date: Tue, 26 Sep 2023 08:59:16 +0000 (+0000) Subject: docs: generate documentation X-Git-Tag: v2.7.5~39 X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=aab0aa502b6d1ca1e2b480460d9cf5f34707c34c;p=poolifier.git docs: generate documentation --- diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 57019215..13d1951e 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -49,7 +49,7 @@ +
  • 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
  • +
  • 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
    • @@ -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
  • +
  • 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
  • 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
  • +
  • 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
  • +
  • Defined in src/worker/abstract-worker.ts:617
    • diff --git a/docs/classes/CircularArray.html b/docs/classes/CircularArray.html index 990a350f..1e4d2785 100644 --- a/docs/classes/CircularArray.html +++ b/docs/classes/CircularArray.html @@ -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
    +
  • 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
    • diff --git a/docs/classes/ClusterWorker.html b/docs/classes/ClusterWorker.html index b1888a6f..c2b001ef 100644 --- a/docs/classes/ClusterWorker.html +++ b/docs/classes/ClusterWorker.html @@ -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
  • +
  • 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
  • +
  • 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
    • diff --git a/docs/classes/Deque.html b/docs/classes/Deque.html index 8035bf37..fb015f84 100644 --- a/docs/classes/Deque.html +++ b/docs/classes/Deque.html @@ -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
  • +
  • Defined in src/deque.ts:12
  • +
  • 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
  • +
  • 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
    • diff --git a/docs/classes/WorkerChoiceStrategyContext.html b/docs/classes/WorkerChoiceStrategyContext.html index 21bd1657..18d877da 100644 --- a/docs/classes/WorkerChoiceStrategyContext.html +++ b/docs/classes/WorkerChoiceStrategyContext.html @@ -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
  • retriesCount: number = 0
    @@ -126,12 +126,12 @@
    +
  • 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
  • +
  • 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
  • +
  • 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
  • +
  • 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
  • +
  • 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
  • +
  • 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
  • +
  • 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
  • +
  • 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
  • +
  • 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
  • +
  • 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
  • +
  • Defined in src/utility-types.ts:170
  • workerNodeKey: number
    @@ -95,7 +95,7 @@
    +
  • Defined in src/utility-types.ts:178
  • +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:156
  • +
  • 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
  • +
  • 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
  • +
  • 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
  • +
  • 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
  • +
  • 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
  • +
  • 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
  • +
  • Defined in src/utility-types.ts:18
  • name: string
    @@ -69,7 +69,7 @@
    +
  • Defined in src/utility-types.ts:14
  • +
  • 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
  • +
  • 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
  • +
  • Defined in src/utility-types.ts:58
  • +
  • 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
  • +
  • Defined in src/pools/worker.ts:21
  • +
  • Defined in src/pools/worker.ts:29
  • +
  • Defined in src/worker/worker-options.ts:18
  • +
  • Defined in src/worker/worker-options.ts:23
  • +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:54
  • +
  • Defined in src/pools/worker.ts:13
  • +
  • Defined in src/pools/worker.ts:8
  • +
  • Defined in src/pools/pool.ts:53
  • +
  • Defined in src/pools/pool.ts:35
  • +
  • Defined in src/worker/task-functions.ts:18
  • +
  • Defined in src/worker/task-functions.ts:7
  • +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:40
  • +
  • Defined in src/pools/worker.ts:217
  • +
  • Defined in src/pools/worker.ts:120
  • +
  • Defined in src/worker/worker-options.ts:4
  • +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:45
  • +
  • Defined in src/pools/pool.ts:40
  • +
  • Defined in src/pools/pool.ts:21
  • +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:4
  • +
  • Defined in src/pools/worker.ts:112