From: Jérôme Benoit Date: Fri, 21 Oct 2022 13:10:36 +0000 (+0200) Subject: Validate documentation generation fix X-Git-Tag: v2.3.5~1 X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=bfed591d93e26b1e424e916abdb27c6f91dc9b45;p=poolifier.git Validate documentation generation fix Signed-off-by: Jérôme Benoit --- diff --git a/docs/classes/ClusterWorker.html b/docs/classes/ClusterWorker.html index 0178263a..68e7fd70 100644 --- a/docs/classes/ClusterWorker.html +++ b/docs/classes/ClusterWorker.html @@ -44,7 +44,7 @@ but the minimum number of workers will be guaranteed.

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

    Returns ClusterWorker<Data, Response>

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

    • Properties

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

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

    • Protected lastTaskTimestamp

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

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

    • Protected mainWorker

    mainWorker: undefined | null | Worker
    +
  • Defined in src/worker/abstract-worker.ts:49

    • Readonly opts

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

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

    • Methods

    @@ -202,7 +202,7 @@ the AsyncResource to which the function is bound.

    Returns void

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

    • emitDestroy

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

    • Protected handleError

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

    • Protected messageListener

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

    • Protected run

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

    • Protected runAsync

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

    • runInAsyncScope

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

      Returns void

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

    • triggerAsyncId

      diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index c6b1cb31..1eec5c4f 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -42,7 +42,7 @@ When the maximum number of workers is reached, an event is emitted. If you want
      • DynamicClusterPool
    +
  • Defined in src/pools/cluster/dynamic.ts:16
    • @@ -135,7 +135,7 @@ When the maximum number of workers is reached, an event is emitted. If you want

    Returns DynamicClusterPool<Data, Response>

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

    • Properties

    @@ -145,13 +145,13 @@ When the maximum number of workers is reached, an event is emitted. If you want

    Inherit Doc

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

    • Readonly filePath

    filePath: string
    +
  • Defined in src/pools/abstract-pool.ts:83

    • Readonly max

    max: number
    @@ -159,7 +159,7 @@ When the maximum number of workers is reached, an event is emitted. If you want

    Inherit Doc

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

    • Protected nextMessageId

    nextMessageId: number = 0
    @@ -167,19 +167,19 @@ When the maximum number of workers is reached, an event is emitted. If you want
    +
  • Defined in src/pools/abstract-pool.ts:61

    • Readonly numberOfWorkers

    numberOfWorkers: number
    +
  • Defined in src/pools/abstract-pool.ts:82

    • Readonly opts

    opts: ClusterPoolOptions = {}
    +
  • Defined in src/pools/cluster/fixed.ts:53

    • Protected promiseMap

    promiseMap: Map<number, PromiseWorkerResponseWrapper<Worker, Response>> = ...
    @@ -192,7 +192,7 @@ When the maximum number of workers is reached, an event is emitted. If you want
    +
  • Defined in src/pools/abstract-pool.ts:53

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -201,7 +201,7 @@ When the maximum number of workers is reached, an event is emitted. If you want
    +
  • Defined in src/pools/abstract-pool.ts:68

    • Readonly workers

    workers: Worker[] = []
    @@ -209,7 +209,7 @@ When the maximum number of workers is reached, an event is emitted. If you want

    Inherit Doc

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

    • Readonly workersTasksUsage

    workersTasksUsage: Map<Worker, TasksUsage> = ...
    @@ -217,7 +217,7 @@ When the maximum number of workers is reached, an event is emitted. If you want

    Inherit Doc

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

    • Accessors

    @@ -230,7 +230,7 @@ When the maximum number of workers is reached, an event is emitted. If you want

    Returns boolean

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

    • numberOfRunningTasks

      @@ -241,7 +241,7 @@ When the maximum number of workers is reached, an event is emitted. If you want

      Returns number

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

    • type

      @@ -252,7 +252,7 @@ When the maximum number of workers is reached, an event is emitted. If you want

      Returns PoolType

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

    • Methods

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

    Returns void

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

    • Protected afterWorkerSetup

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

    • Protected beforePromiseWorkerResponseHook

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

    • Protected chooseWorker

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • destroyWorker

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

    • execute

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

    • findFreeWorker

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

    • getWorkerAverageTasksRunTime

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

    • getWorkerIndex

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

    • getWorkerRunningTasks

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

    • initWorkerTasksUsage

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

    • Protected internalExecute

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

    • Protected internalGetBusyStatus

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

    • Protected isMain

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

    • registerWorkerMessageListener

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

    • Protected removeWorker

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

    • Protected sendToWorker

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

    • setWorkerChoiceStrategy

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

    • Protected setupHook

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

    • Protected workerListener

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

      Returns void

    +
  • Defined in src/pools/abstract-pool.ts:368
    • diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index 46fc6924..d1814a4c 100644 --- a/docs/classes/DynamicThreadPool.html +++ b/docs/classes/DynamicThreadPool.html @@ -42,7 +42,7 @@ When the maximum number of threads is reached, an event is emitted. If you want
    • DynamicThreadPool
    +
  • Defined in src/pools/thread/dynamic.ts:17
    • @@ -135,7 +135,7 @@ When the maximum number of threads is reached, an event is emitted. If you want

    Returns DynamicThreadPool<Data, Response>

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

    • Properties

    @@ -145,13 +145,13 @@ When the maximum number of threads is reached, an event is emitted. If you want

    Inherit Doc

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

    • Readonly filePath

    filePath: string
    +
  • Defined in src/pools/abstract-pool.ts:83

    • Readonly max

    max: number
    @@ -159,7 +159,7 @@ When the maximum number of threads is reached, an event is emitted. If you want

    Inherit Doc

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

    • Protected nextMessageId

    nextMessageId: number = 0
    @@ -167,19 +167,19 @@ When the maximum number of threads is reached, an event is emitted. If you want
    +
  • Defined in src/pools/abstract-pool.ts:61

    • Readonly numberOfWorkers

    numberOfWorkers: number
    +
  • Defined in src/pools/abstract-pool.ts:82

    • Readonly opts

    opts: PoolOptions<ThreadWorkerWithMessageChannel>
    +
  • Defined in src/pools/abstract-pool.ts:84

    • Protected promiseMap

    promiseMap: Map<number, PromiseWorkerResponseWrapper<ThreadWorkerWithMessageChannel, Response>> = ...
    @@ -192,7 +192,7 @@ When the maximum number of threads is reached, an event is emitted. If you want
    +
  • Defined in src/pools/abstract-pool.ts:53

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<ThreadWorkerWithMessageChannel, Data, Response>
    @@ -201,7 +201,7 @@ When the maximum number of threads is reached, an event is emitted. If you want
    +
  • Defined in src/pools/abstract-pool.ts:68

    • Readonly workers

    workers: ThreadWorkerWithMessageChannel[] = []
    @@ -209,7 +209,7 @@ When the maximum number of threads is reached, an event is emitted. If you want

    Inherit Doc

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

    • Readonly workersTasksUsage

    workersTasksUsage: Map<ThreadWorkerWithMessageChannel, TasksUsage> = ...
    @@ -217,7 +217,7 @@ When the maximum number of threads is reached, an event is emitted. If you want

    Inherit Doc

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

    • Accessors

    @@ -230,7 +230,7 @@ When the maximum number of threads is reached, an event is emitted. If you want

    Returns boolean

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

    • numberOfRunningTasks

      @@ -241,7 +241,7 @@ When the maximum number of threads is reached, an event is emitted. If you want

      Returns number

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

    • type

      @@ -252,7 +252,7 @@ When the maximum number of threads is reached, an event is emitted. If you want

      Returns PoolType

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

    • Methods

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

    Returns void

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

    • Protected afterWorkerSetup

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

    • Protected beforePromiseWorkerResponseHook

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

    • Protected chooseWorker

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • destroyWorker

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

    • execute

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

    • findFreeWorker

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

    • getWorkerAverageTasksRunTime

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

    • getWorkerIndex

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

    • getWorkerRunningTasks

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

    • initWorkerTasksUsage

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

    • Protected internalExecute

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

    • Protected internalGetBusyStatus

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

    • Protected isMain

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

    • registerWorkerMessageListener

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

    • Protected removeWorker

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

    • Protected sendToWorker

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

    • setWorkerChoiceStrategy

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

    • Protected setupHook

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

    • Protected workerListener

      @@ -632,7 +632,7 @@ to run code before workers are created in the abstract constructor.

      Returns void

    +
  • Defined in src/pools/abstract-pool.ts:368
    • diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index a376cf01..2076e589 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -44,7 +44,7 @@ +
  • Defined in src/pools/cluster/fixed.ts:39
    • @@ -133,7 +133,7 @@

    Returns FixedClusterPool<Data, Response>

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

    • Properties

    @@ -143,13 +143,13 @@

    Inherit Doc

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

    • Readonly filePath

    filePath: string
    +
  • Defined in src/pools/abstract-pool.ts:83

    • Optional Readonly max

    max?: number
    @@ -157,7 +157,7 @@

    Inherit Doc

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

    • Protected nextMessageId

    nextMessageId: number = 0
    @@ -165,19 +165,19 @@
    +
  • Defined in src/pools/abstract-pool.ts:61

    • Readonly numberOfWorkers

    numberOfWorkers: number
    +
  • Defined in src/pools/abstract-pool.ts:82

    • Readonly opts

    opts: ClusterPoolOptions = {}
    +
  • Defined in src/pools/cluster/fixed.ts:53

    • Protected promiseMap

    promiseMap: Map<number, PromiseWorkerResponseWrapper<Worker, Response>> = ...
    @@ -190,7 +190,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:53

    • Protected workerChoiceStrategyContext

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

    • Readonly workers

    workers: Worker[] = []
    @@ -207,7 +207,7 @@

    Inherit Doc

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

    • Readonly workersTasksUsage

    workersTasksUsage: Map<Worker, TasksUsage> = ...
    @@ -215,7 +215,7 @@

    Inherit Doc

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

    • Accessors

    @@ -228,7 +228,7 @@

    Returns boolean

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

    • numberOfRunningTasks

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

    • type

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

    • Methods

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

    Returns void

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

    • Protected afterWorkerSetup

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

    • Protected beforePromiseWorkerResponseHook

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

      Returns void

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

    • Protected chooseWorker

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • destroyWorker

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

    • execute

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

    • findFreeWorker

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

    • getWorkerAverageTasksRunTime

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

      Returns undefined | number

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

    • getWorkerIndex

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

    • getWorkerRunningTasks

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

      Returns undefined | number

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

    • initWorkerTasksUsage

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

    • Protected internalExecute

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

      Returns Promise<Response>

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

    • Protected internalGetBusyStatus

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

    • Protected isMain

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

    • registerWorkerMessageListener

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

      Returns void

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

    • Protected removeWorker

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

    • Protected sendToWorker

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

    • setWorkerChoiceStrategy

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

    • Protected setupHook

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

    • Protected workerListener

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

      Returns void

    +
  • Defined in src/pools/abstract-pool.ts:368
    • diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index 6a558260..1e6bea45 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -44,7 +44,7 @@ +
  • Defined in src/pools/thread/fixed.ts:24
    • @@ -133,7 +133,7 @@

    Returns FixedThreadPool<Data, Response>

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

    • Properties

    @@ -143,13 +143,13 @@

    Inherit Doc

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

    • Readonly filePath

    filePath: string
    +
  • Defined in src/pools/abstract-pool.ts:83

    • Optional Readonly max

    max?: number
    @@ -157,7 +157,7 @@

    Inherit Doc

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

    • Protected nextMessageId

    nextMessageId: number = 0
    @@ -165,19 +165,19 @@
    +
  • Defined in src/pools/abstract-pool.ts:61

    • Readonly numberOfWorkers

    numberOfWorkers: number
    +
  • Defined in src/pools/abstract-pool.ts:82

    • Readonly opts

    opts: PoolOptions<ThreadWorkerWithMessageChannel>
    +
  • Defined in src/pools/abstract-pool.ts:84

    • Protected promiseMap

    promiseMap: Map<number, PromiseWorkerResponseWrapper<ThreadWorkerWithMessageChannel, Response>> = ...
    @@ -190,7 +190,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:53

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<ThreadWorkerWithMessageChannel, Data, Response>
    @@ -199,7 +199,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:68

    • Readonly workers

    workers: ThreadWorkerWithMessageChannel[] = []
    @@ -207,7 +207,7 @@

    Inherit Doc

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

    • Readonly workersTasksUsage

    workersTasksUsage: Map<ThreadWorkerWithMessageChannel, TasksUsage> = ...
    @@ -215,7 +215,7 @@

    Inherit Doc

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

    • Accessors

    @@ -228,7 +228,7 @@

    Returns boolean

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

    • numberOfRunningTasks

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

    • type

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

    • Methods

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

    Returns void

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

    • Protected afterWorkerSetup

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

    • Protected beforePromiseWorkerResponseHook

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

      Returns void

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

    • Protected chooseWorker

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • destroyWorker

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

    • execute

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

    • findFreeWorker

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

    • getWorkerAverageTasksRunTime

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

      Returns undefined | number

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

    • getWorkerIndex

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

    • getWorkerRunningTasks

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

      Returns undefined | number

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

    • initWorkerTasksUsage

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

    • Protected internalExecute

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

      Returns Promise<Response>

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

    • Protected internalGetBusyStatus

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

    • Protected isMain

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

    • registerWorkerMessageListener

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

      Returns void

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

    • Protected removeWorker

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

    • Protected sendToWorker

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

    • setWorkerChoiceStrategy

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

    • Protected setupHook

      @@ -602,7 +602,7 @@ to run code before workers are created in the abstract constructor.

      Returns void

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

    • Protected workerListener

      @@ -630,7 +630,7 @@ to run code before workers are created in the abstract constructor.

      Returns void

    +
  • Defined in src/pools/abstract-pool.ts:368
    • diff --git a/docs/classes/PoolEmitter.html b/docs/classes/PoolEmitter.html index 62a19ed6..b753f9d7 100644 --- a/docs/classes/PoolEmitter.html +++ b/docs/classes/PoolEmitter.html @@ -25,7 +25,7 @@
    • PoolEmitter
    +
  • Defined in src/pools/pool.ts:13
    • diff --git a/docs/classes/ThreadWorker.html b/docs/classes/ThreadWorker.html index ac2a5fda..ddc36c9d 100644 --- a/docs/classes/ThreadWorker.html +++ b/docs/classes/ThreadWorker.html @@ -44,7 +44,7 @@ but the minimum number of workers will be guaranteed.

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

    Returns ThreadWorker<Data, Response>

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

    • Properties

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

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

    • Protected lastTaskTimestamp

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

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

    • Protected mainWorker

    mainWorker: undefined | null | MessagePort
    +
  • Defined in src/worker/abstract-worker.ts:49

    • Readonly opts

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

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

    • Methods

    @@ -202,7 +202,7 @@ the AsyncResource to which the function is bound.

    Returns void

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

    • emitDestroy

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

    • Protected handleError

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

    • Protected messageListener

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

    • Protected run

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

    • Protected runAsync

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

    • runInAsyncScope

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

      Returns void

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

    • triggerAsyncId

      diff --git a/docs/interfaces/ClusterPoolOptions.html b/docs/interfaces/ClusterPoolOptions.html index 19793cf3..038ad0f6 100644 --- a/docs/interfaces/ClusterPoolOptions.html +++ b/docs/interfaces/ClusterPoolOptions.html @@ -25,7 +25,7 @@
      • ClusterPoolOptions
    +
  • Defined in src/pools/cluster/fixed.ts:11
    • @@ -53,7 +53,7 @@
    +
  • Defined in src/pools/pool.ts:44

    • Optional env

    env?: any
    @@ -62,7 +62,7 @@

    See

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

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

    • Optional errorHandler

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

    • Optional exitHandler

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

    • Optional messageHandler

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

    • Optional onlineHandler

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

    • Optional settings

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

    See

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

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

    • Optional workerChoiceStrategy

    workerChoiceStrategy?: "ROUND_ROBIN" | "LESS_RECENTLY_USED" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
    @@ -111,7 +111,7 @@
    +
  • Defined in src/pools/pool.ts:38
    • diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 7d1df8f7..3e933bc2 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -34,7 +34,7 @@
    • IPool
    +
  • Defined in src/pools/pool.ts:53
    • @@ -62,7 +62,7 @@
    +
  • Defined in src/pools/pool.ts:61

    • Methods

    @@ -74,7 +74,7 @@

    Returns Promise<void>

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

    • execute

      @@ -93,7 +93,7 @@

    Returns Promise<Response>

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

    • setWorkerChoiceStrategy

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

    Returns void

    +
  • Defined in src/pools/pool.ts:78
    • diff --git a/docs/interfaces/PoolOptions.html b/docs/interfaces/PoolOptions.html index 7cdb0c56..8993db24 100644 --- a/docs/interfaces/PoolOptions.html +++ b/docs/interfaces/PoolOptions.html @@ -30,7 +30,7 @@ +
  • Defined in src/pools/pool.ts:18
    • @@ -55,42 +55,42 @@

    Default

    true

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

    • Optional errorHandler

    errorHandler?: ErrorHandler<Worker>

    A function that will listen for error event on each worker.

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

    • Optional exitHandler

    exitHandler?: ExitHandler<Worker>

    A function that will listen for exit event on each worker.

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

    • Optional messageHandler

    messageHandler?: MessageHandler<Worker>

    A function that will listen for message event on each worker.

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

    • Optional onlineHandler

    onlineHandler?: OnlineHandler<Worker>

    A function that will listen for online event on each worker.

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

    • Optional workerChoiceStrategy

    workerChoiceStrategy?: "ROUND_ROBIN" | "LESS_RECENTLY_USED" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"

    The worker choice strategy to use in this pool.

    +
  • Defined in src/pools/pool.ts:38
    • diff --git a/docs/interfaces/WorkerOptions.html b/docs/interfaces/WorkerOptions.html index a47f24d6..3458ccfa 100644 --- a/docs/interfaces/WorkerOptions.html +++ b/docs/interfaces/WorkerOptions.html @@ -23,7 +23,7 @@
    • WorkerOptions
    +
  • Defined in src/worker/worker-options.ts:38
    • @@ -45,7 +45,7 @@

    Default

    false

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

    • Optional killBehavior

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

    Default

    KillBehaviors.SOFT

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

    • Optional maxInactiveTime

    maxInactiveTime?: number
    @@ -75,7 +75,7 @@ when this timeout expires your tasks is interrupted and the worker is killed if

    Default

    60000 ms

    +
  • Defined in src/worker/worker-options.ts:51
    • diff --git a/docs/types/ErrorHandler.html b/docs/types/ErrorHandler.html index b6bd0e6a..c006f86d 100644 --- a/docs/types/ErrorHandler.html +++ b/docs/types/ErrorHandler.html @@ -39,7 +39,7 @@
    e: Error

    Returns void

    +
  • Defined in src/pools/pool-worker.ts:9
    • diff --git a/docs/types/ExitHandler.html b/docs/types/ExitHandler.html index 06d6cc14..15005e1f 100644 --- a/docs/types/ExitHandler.html +++ b/docs/types/ExitHandler.html @@ -39,7 +39,7 @@
    code: number

    Returns void

    +
  • Defined in src/pools/pool-worker.ts:19
    • diff --git a/docs/types/KillBehavior.html b/docs/types/KillBehavior.html index 098af454..7a8728a4 100644 --- a/docs/types/KillBehavior.html +++ b/docs/types/KillBehavior.html @@ -19,7 +19,7 @@

    Kill behavior.

    +
  • Defined in src/worker/worker-options.ts:18
    • diff --git a/docs/types/MessageHandler.html b/docs/types/MessageHandler.html index c509e37a..3e111073 100644 --- a/docs/types/MessageHandler.html +++ b/docs/types/MessageHandler.html @@ -39,7 +39,7 @@
    m: unknown

    Returns void

    +
  • Defined in src/pools/pool-worker.ts:4
    • diff --git a/docs/types/OnlineHandler.html b/docs/types/OnlineHandler.html index 4e4e76f1..ee92dd82 100644 --- a/docs/types/OnlineHandler.html +++ b/docs/types/OnlineHandler.html @@ -37,7 +37,7 @@
    this: Worker

    Returns void

    +
  • Defined in src/pools/pool-worker.ts:14
    • diff --git a/docs/types/ThreadWorkerWithMessageChannel.html b/docs/types/ThreadWorkerWithMessageChannel.html index e8e68d3a..02706450 100644 --- a/docs/types/ThreadWorkerWithMessageChannel.html +++ b/docs/types/ThreadWorkerWithMessageChannel.html @@ -19,7 +19,7 @@

    A thread worker with message channels for communication between main thread and thread worker.

    +
  • Defined in src/pools/thread/fixed.ts:10
    • diff --git a/docs/types/WorkerChoiceStrategy.html b/docs/types/WorkerChoiceStrategy.html index b43f2078..537014ce 100644 --- a/docs/types/WorkerChoiceStrategy.html +++ b/docs/types/WorkerChoiceStrategy.html @@ -19,7 +19,7 @@

    Worker choice strategy.

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:28
    • diff --git a/docs/variables/KillBehaviors.html b/docs/variables/KillBehaviors.html index d09e5f3a..5cd1ab82 100644 --- a/docs/variables/KillBehaviors.html +++ b/docs/variables/KillBehaviors.html @@ -19,7 +19,7 @@

    Enumeration of kill behaviors.

    +
  • Defined in src/worker/worker-options.ts:4
    • diff --git a/docs/variables/WorkerChoiceStrategies.html b/docs/variables/WorkerChoiceStrategies.html index 71256489..10cda027 100644 --- a/docs/variables/WorkerChoiceStrategies.html +++ b/docs/variables/WorkerChoiceStrategies.html @@ -19,7 +19,7 @@

    Enumeration of worker choice strategies.

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