From 67ff85c0f9bf4f18372728327fc5373f17d9e13a Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Sat, 18 Mar 2023 17:50:36 +0000 Subject: [PATCH] chore: generate documentation --- docs/classes/ClusterWorker.html | 28 +++---- docs/classes/DynamicClusterPool.html | 76 +++++++++---------- docs/classes/DynamicThreadPool.html | 72 +++++++++--------- docs/classes/FixedClusterPool.html | 74 +++++++++--------- docs/classes/FixedThreadPool.html | 70 ++++++++--------- docs/classes/PoolEmitter.html | 2 +- docs/classes/ThreadWorker.html | 28 +++---- docs/interfaces/ClusterPoolOptions.html | 18 ++--- docs/interfaces/IPool.html | 10 +-- docs/interfaces/PoolOptions.html | 14 ++-- docs/interfaces/WorkerOptions.html | 8 +- 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, 209 insertions(+), 209 deletions(-) diff --git a/docs/classes/ClusterWorker.html b/docs/classes/ClusterWorker.html index fa6c6898..cdfaa2f0 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
    • @@ -112,13 +112,13 @@ but the minimum number of workers will be guaranteed.

    data: Data

    Returns Response

  • -
    opts: WorkerOptions = EMPTY_OBJECT_LITERAL
    +
    opts: WorkerOptions = {}

    Options for the worker.

    • 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,7 +136,7 @@ but the minimum number of workers will be guaranteed.

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

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

    • Readonly opts

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

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

    • Methods

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

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

    • triggerAsyncId

    +
  • Defined in src/pools/cluster/dynamic.ts:16
    • @@ -127,13 +127,13 @@ When the maximum number of workers is reached, an event is emitted. If you want

    Path to an implementation of a ClusterWorker file, which can be relative or absolute.

  • -
    opts: ClusterPoolOptions = EMPTY_OBJECT_LITERAL
    +
    opts: ClusterPoolOptions = {}

    Options for this dynamic cluster pool.

    • 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,15 +174,15 @@ 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 = EMPTY_OBJECT_LITERAL
    +
    opts: ClusterPoolOptions = {}

    Options for this fixed cluster pool.

    +
  • 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 f3134790..2e15a586 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 4d368148..17b622ad 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -44,7 +44,7 @@ +
  • Defined in src/pools/cluster/fixed.ts:39
    • @@ -124,13 +124,13 @@

    Path to an implementation of a ClusterWorker file, which can be relative or absolute.

  • -
    opts: ClusterPoolOptions = EMPTY_OBJECT_LITERAL
    +
    opts: ClusterPoolOptions = {}

    Options for this fixed cluster pool.

    • 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,15 +164,15 @@
    +
  • Defined in src/pools/abstract-pool.ts:79

    • Readonly opts

    -
    opts: ClusterPoolOptions = EMPTY_OBJECT_LITERAL
    +
    opts: ClusterPoolOptions = {}

    Options for this fixed cluster pool.

    +
  • 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 f8b60f70..a5610b10 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 9c21d21d..fa3c8da9 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 6f515740..dbe61aca 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
    • @@ -112,13 +112,13 @@ but the minimum number of workers will be guaranteed.

    data: Data

    Returns Response

  • -
    opts: WorkerOptions = EMPTY_OBJECT_LITERAL
    +
    opts: WorkerOptions = {}

    Options for the worker.

    • 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,7 +136,7 @@ but the minimum number of workers will be guaranteed.

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

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

    • Readonly opts

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

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

    • Methods

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

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

    • triggerAsyncId

    +
  • 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 f8cfa2e8..e6efa97a 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 d13801bd..68d458fb 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 dd50cfda..25d539d4 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 Value

    false

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

    • Optional killBehavior

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

    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 40599964..ce89a561 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 8fb4c053..209203fd 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 72828be0..57ba81cd 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 898301e0..22461c13 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 9774b669..5eeae7f8 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 dd9d804c..e7ac315a 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 59dac8b1..92916f8a 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 658ee5f4..b465f030 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 f5fde306..e0fa6535 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