From e1230e386080ae19766e2a7863c807a90f13a3ef Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Sat, 1 Apr 2023 20:26:35 +0000 Subject: [PATCH] chore: generate documentation --- docs/classes/ClusterWorker.html | 38 +++++----- docs/classes/DynamicClusterPool.html | 72 +++++++++---------- docs/classes/DynamicThreadPool.html | 72 +++++++++---------- docs/classes/FixedClusterPool.html | 70 +++++++++--------- docs/classes/FixedThreadPool.html | 70 +++++++++--------- docs/classes/PoolEmitter.html | 54 +++++++------- docs/classes/ThreadWorker.html | 38 +++++----- docs/interfaces/ClusterPoolOptions.html | 18 ++--- docs/interfaces/IPool.html | 10 +-- docs/interfaces/PoolOptions.html | 14 ++-- docs/interfaces/WorkerOptions.html | 10 +-- docs/types/ErrorHandler.html | 2 +- docs/types/ExitHandler.html | 2 +- docs/types/KillBehavior.html | 2 +- docs/types/MessageHandler.html | 2 +- docs/types/OnlineHandler.html | 2 +- .../types/ThreadWorkerWithMessageChannel.html | 2 +- docs/types/WorkerChoiceStrategy.html | 2 +- docs/variables/KillBehaviors.html | 2 +- docs/variables/WorkerChoiceStrategies.html | 2 +- 20 files changed, 242 insertions(+), 242 deletions(-) diff --git a/docs/classes/ClusterWorker.html b/docs/classes/ClusterWorker.html index ae4fe016..770c6edb 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:35

    • Protected lastTaskTimestamp

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

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

    • Protected mainWorker

    mainWorker: undefined | null | Worker
    @@ -144,7 +144,7 @@ but the minimum number of workers will be guaranteed.

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

    • Readonly opts

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

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

    • Methods

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

    Returns number

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

    • bind

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

    • Protected checkAlive

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

    • emitDestroy

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

    • Protected getMainWorker

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

    • Protected handleError

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

    • Protected messageListener

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

    • Protected run

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

    • Protected runAsync

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

    • runInAsyncScope

    +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:303

    • Protected sendToMainWorker

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

    • triggerAsyncId

    +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:320

    • Static bind

    +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:273
    • diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 0a537f5f..72689ccd 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
    • @@ -133,7 +133,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

    @@ -143,7 +143,7 @@ When the maximum number of workers is reached, an event is emitted. If you want
    +
  • Defined in src/pools/abstract-pool.ts:40

    • Readonly filePath

    filePath: string
    @@ -151,14 +151,14 @@ When the maximum number of workers is reached, an event is emitted. If you want
    +
  • Defined in src/pools/abstract-pool.ts:80

    • Protected Readonly max

    max: number

    Maximum number of workers that can be created by this pool.

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

    • Protected nextMessageId

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

    • Readonly numberOfWorkers

    numberOfWorkers: number
    @@ -174,7 +174,7 @@ When the maximum number of workers is reached, an event is emitted. If you want
    +
  • Defined in src/pools/abstract-pool.ts:79

    • Readonly opts

    opts: ClusterPoolOptions = {}
    @@ -182,7 +182,7 @@ When the maximum number of workers is reached, an event is emitted. If you want
    +
  • Defined in src/pools/cluster/fixed.ts:53

    • Protected promiseMap

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

    • Protected workerChoiceStrategyContext

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

    • Readonly workers

    workers: Worker[] = []
    @@ -212,7 +212,7 @@ When the maximum number of workers is reached, an event is emitted. If you want
    +
  • Defined in src/pools/abstract-pool.ts:31

    • Readonly workersTasksUsage

    workersTasksUsage: Map<Worker, TasksUsage> = ...
    @@ -220,7 +220,7 @@ When the maximum number of workers is reached, an event is emitted. If you want
    +
  • Defined in src/pools/abstract-pool.ts:34

    • Accessors

    @@ -233,7 +233,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

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

    • type

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

    • Methods

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

    Returns void

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

    • Protected afterWorkerSetup

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

    • Protected beforePromiseWorkerResponseHook

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

    • Protected chooseWorker

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • destroyWorker

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

    • execute

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

    • findFreeWorker

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

    • getWorkerAverageTasksRunTime

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

    • getWorkerIndex

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

    • getWorkerRunningTasks

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

    • Protected internalGetBusyStatus

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

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

    • Protected sendToWorker

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

    • setWorkerChoiceStrategy

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:363
    • diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index f61c7c4e..c606731b 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
    • @@ -133,7 +133,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

    @@ -143,7 +143,7 @@ When the maximum number of threads is reached, an event is emitted. If you want
    +
  • Defined in src/pools/abstract-pool.ts:40

    • Readonly filePath

    filePath: string
    @@ -151,14 +151,14 @@ When the maximum number of threads is reached, an event is emitted. If you want
    +
  • Defined in src/pools/abstract-pool.ts:80

    • Protected Readonly max

    max: number

    Maximum number of threads that can be created by this pool.

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

    • Protected nextMessageId

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

    • Readonly numberOfWorkers

    numberOfWorkers: number
    @@ -174,7 +174,7 @@ When the maximum number of threads is reached, an event is emitted. If you want
    +
  • Defined in src/pools/abstract-pool.ts:79

    • Readonly opts

    opts: PoolOptions<ThreadWorkerWithMessageChannel>
    @@ -182,7 +182,7 @@ When the maximum number of threads is reached, an event is emitted. If you want
    +
  • Defined in src/pools/abstract-pool.ts:81

    • Protected promiseMap

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

    • Protected workerChoiceStrategyContext

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

    • Readonly workers

    workers: ThreadWorkerWithMessageChannel[] = []
    @@ -212,7 +212,7 @@ When the maximum number of threads is reached, an event is emitted. If you want
    +
  • Defined in src/pools/abstract-pool.ts:31

    • Readonly workersTasksUsage

    workersTasksUsage: Map<ThreadWorkerWithMessageChannel, TasksUsage> = ...
    @@ -220,7 +220,7 @@ When the maximum number of threads is reached, an event is emitted. If you want
    +
  • Defined in src/pools/abstract-pool.ts:34

    • Accessors

    @@ -233,7 +233,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

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

    • type

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

    • Methods

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

    Returns void

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

    • Protected afterWorkerSetup

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

    • Protected beforePromiseWorkerResponseHook

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

    • Protected chooseWorker

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • destroyWorker

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

    • execute

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

    • findFreeWorker

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

    • getWorkerAverageTasksRunTime

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

    • getWorkerIndex

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

    • getWorkerRunningTasks

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

    • Protected internalGetBusyStatus

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

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

    • Protected sendToWorker

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

    • setWorkerChoiceStrategy

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:363
    • diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 66464cec..8dc3e624 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -44,7 +44,7 @@ +
  • Defined in src/pools/cluster/fixed.ts:39
    • @@ -130,7 +130,7 @@

    Returns FixedClusterPool<Data, Response>

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

    • Properties

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

    • Readonly filePath

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

    • Protected nextMessageId

    nextMessageId: number = 0
    @@ -156,7 +156,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:58

    • Readonly numberOfWorkers

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

    • Readonly opts

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

    • Protected promiseMap

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

    • Protected workerChoiceStrategyContext

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

    • Readonly workers

    workers: Worker[] = []
    @@ -202,7 +202,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:31

    • Readonly workersTasksUsage

    workersTasksUsage: Map<Worker, TasksUsage> = ...
    @@ -210,7 +210,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:34

    • Accessors

    @@ -223,7 +223,7 @@

    Returns boolean

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

    • numberOfRunningTasks

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

    • type

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

    • Methods

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

    Returns void

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

    • Protected afterWorkerSetup

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

    • Protected beforePromiseWorkerResponseHook

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

    • Protected chooseWorker

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • destroyWorker

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

    • execute

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

    • findFreeWorker

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

    • getWorkerAverageTasksRunTime

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

    • getWorkerIndex

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

    • getWorkerRunningTasks

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

    • Protected internalGetBusyStatus

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

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

    • Protected sendToWorker

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

    • setWorkerChoiceStrategy

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:363
    • diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index a7ecfda3..3d80e162 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -44,7 +44,7 @@ +
  • Defined in src/pools/thread/fixed.ts:24
    • @@ -130,7 +130,7 @@

    Returns FixedThreadPool<Data, Response>

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

    • Properties

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

    • Readonly filePath

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

    • Protected nextMessageId

    nextMessageId: number = 0
    @@ -156,7 +156,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:58

    • Readonly numberOfWorkers

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

    • Readonly opts

    opts: PoolOptions<ThreadWorkerWithMessageChannel>
    @@ -172,7 +172,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:81

    • Protected promiseMap

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

    • Protected workerChoiceStrategyContext

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

    • Readonly workers

    workers: ThreadWorkerWithMessageChannel[] = []
    @@ -202,7 +202,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:31

    • Readonly workersTasksUsage

    workersTasksUsage: Map<ThreadWorkerWithMessageChannel, TasksUsage> = ...
    @@ -210,7 +210,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:34

    • Accessors

    @@ -223,7 +223,7 @@

    Returns boolean

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

    • numberOfRunningTasks

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

    • type

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

    • Methods

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

    Returns void

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

    • Protected afterWorkerSetup

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

    • Protected beforePromiseWorkerResponseHook

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

    • Protected chooseWorker

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • destroyWorker

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

    • execute

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

    • findFreeWorker

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

    • getWorkerAverageTasksRunTime

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

    • getWorkerIndex

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

    • getWorkerRunningTasks

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

    • Protected internalGetBusyStatus

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

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

    • Protected sendToWorker

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

    • setWorkerChoiceStrategy

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:363
    • diff --git a/docs/classes/PoolEmitter.html b/docs/classes/PoolEmitter.html index 066c4bed..efba10e6 100644 --- a/docs/classes/PoolEmitter.html +++ b/docs/classes/PoolEmitter.html @@ -25,7 +25,7 @@
    • PoolEmitter
    +
  • Defined in src/pools/pool.ts:13
    • @@ -80,7 +80,7 @@

    Returns PoolEmitter

    +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/events.d.ts:111

    • Properties

    @@ -88,7 +88,7 @@
    captureRejectionSymbol: typeof captureRejectionSymbol
    +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/events.d.ts:328

    • Static captureRejections

    captureRejections: boolean
    @@ -96,13 +96,13 @@
    +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/events.d.ts:333

    • Static defaultMaxListeners

    defaultMaxListeners: number
    +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/events.d.ts:334

    • Static Readonly errorMonitor

    errorMonitor: typeof errorMonitor
    @@ -115,7 +115,7 @@ regular 'error' listener is installed.

    +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/events.d.ts:327

    • Methods

    @@ -148,7 +148,7 @@ regular 'error' listener is installed.

    Returns PoolEmitter

    +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/events.d.ts:354

    • emit

    +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/events.d.ts:610

    • eventNames

    +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/events.d.ts:669

    • getMaxListeners

    +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/events.d.ts:526

    • listenerCount

    +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/events.d.ts:616

    • listeners

    +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/events.d.ts:539

    • off

    +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/events.d.ts:499

    • on

    +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/events.d.ts:385

    • once

    +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/events.d.ts:414

    • prependListener

    +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/events.d.ts:634

    • prependOnceListener

    +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/events.d.ts:650

    • rawListeners

    +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/events.d.ts:569

    • removeAllListeners

    +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/events.d.ts:510

    • removeListener

    +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/events.d.ts:494

    • setMaxListeners

    +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/events.d.ts:520

    • Static getEventListeners

    +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/events.d.ts:299

    • Static listenerCount

    +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/events.d.ts:271

    • Static on

    +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/events.d.ts:254

    • Static once

  • @@ -699,7 +699,7 @@ special handling:

    Returns Promise<any[]>

    • +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/events.d.ts:195

    • Static setMaxListeners

    +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/events.d.ts:317
    • diff --git a/docs/classes/ThreadWorker.html b/docs/classes/ThreadWorker.html index a01d1b73..3af0a7ce 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:35

    • Protected lastTaskTimestamp

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

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

    • Protected mainWorker

    mainWorker: undefined | null | MessagePort
    @@ -144,7 +144,7 @@ but the minimum number of workers will be guaranteed.

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

    • Readonly opts

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

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

    • Methods

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

    Returns number

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

    • bind

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

    • Protected checkAlive

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

    • emitDestroy

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

    • Protected getMainWorker

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

    • Protected handleError

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

    • Protected messageListener

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

    • Protected run

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

    • Protected runAsync

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

    • runInAsyncScope

    +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:303

    • Protected sendToMainWorker

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

    • triggerAsyncId

    +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:320

    • Static bind

    +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:273
    • diff --git a/docs/interfaces/ClusterPoolOptions.html b/docs/interfaces/ClusterPoolOptions.html index b9f496a3..b7882c77 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 520a5ea3..2f0722e9 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -34,7 +34,7 @@
    • IPool
    +
  • Defined in src/pools/pool.ts:53
    • @@ -63,7 +63,7 @@

    Returns Promise<void>

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

    • Optional Readonly emitter

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

    • execute

    execute: ((data: Data) => Promise<Response>)
    @@ -98,7 +98,7 @@

    Returns Promise<Response>

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

    • setWorkerChoiceStrategy

    setWorkerChoiceStrategy: ((workerChoiceStrategy: "ROUND_ROBIN" | "LESS_RECENTLY_USED" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN") => void)
    @@ -120,7 +120,7 @@

    Returns void

    +
  • Defined in src/pools/pool.ts:78
    • diff --git a/docs/interfaces/PoolOptions.html b/docs/interfaces/PoolOptions.html index 60903f27..a138985b 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 Value

    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 7cb5491b..f1fe5415 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,21 +45,21 @@

    Default Value

    false

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

    • Optional killBehavior

    killBehavior?: "SOFT" | "HARD"

    killBehavior dictates if your async unit (worker/process) will be deleted in case that a task is active on it.

    • SOFT: If currentTime - lastActiveTime is greater than maxInactiveTime but a task is still running, then the worker won't be deleted.
      • -
    • HARD: If lastActiveTime is greater than maxInactiveTime but a task is still running, then the worker will be deleted.
      • +
    • HARD: If currentTime - lastActiveTime is greater than maxInactiveTime but a task is still running, then the worker will be deleted.

    This option only apply to the newly created workers.

    Default Value

    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 Value

    60000 ms

    +
  • Defined in src/worker/worker-options.ts:51
    • diff --git a/docs/types/ErrorHandler.html b/docs/types/ErrorHandler.html index bed0adf6..b62225cd 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 1a547558..f9f4e79d 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 8346a5c7..88d32be2 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 8498d6b1..75a00bfe 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 26c165b5..3b58ef56 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 bf920900..96c93fe1 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 c1962232..6fd165dd 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 06e24616..e7394a65 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 4ac8f137..7d79c99e 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
    • -- 2.34.1