From: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 7 Apr 2023 12:51:59 +0000 (+0000) Subject: chore: generate documentation X-Git-Tag: v2.4.3~4 X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=71a64eca52278c2396cf7cb6e6c53fce3704f5ab;p=poolifier.git chore: generate documentation --- diff --git a/docs/classes/ClusterWorker.html b/docs/classes/ClusterWorker.html index 8c0f1bf2..7fc56890 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
    • @@ -119,7 +119,7 @@ but the minimum number of workers will be guaranteed.

    Returns ClusterWorker<Data, Response>

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

    • Properties

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

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

    • Protected Readonly isMain

    isMain: boolean
    @@ -137,7 +137,7 @@ but the minimum number of workers will be guaranteed.

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

    • Protected lastTaskTimestamp

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

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

    • Protected mainWorker

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

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

    • Readonly opts

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

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

    • Methods

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

    Returns void

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

    • emitDestroy

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

    • Protected handleError

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

    • Protected messageListener

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

    • Protected run

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

    • Protected runAsync

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

    • runInAsyncScope

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

    • triggerAsyncId

    +
  • Defined in src/pools/cluster/dynamic.ts:16
    • @@ -129,17 +129,17 @@ When the maximum number of workers is reached and workers are busy, an event is

    Returns DynamicClusterPool<Data, Response>

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

    • Properties

    Optional Readonly emitter

    emitter?: PoolEmitter
    -

    {@inheritDoc}

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

    • Readonly filePath

    filePath: string
    @@ -147,14 +147,14 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:67

    • Private Readonly max

    max: number

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

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

    • Readonly numberOfWorkers

    numberOfWorkers: number
    @@ -162,7 +162,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:66

    • Readonly opts

    opts: ClusterPoolOptions = {}
    @@ -170,7 +170,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/cluster/fixed.ts:53

    • Protected promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<Worker, Response>> = ...
    @@ -183,7 +183,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:42

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -192,15 +192,15 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:52

    • Readonly workers

    workers: WorkerType<Worker>[] = []
    -

    {@inheritDoc}

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

    • Accessors

    @@ -208,23 +208,23 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/cluster/dynamic.ts:48

    • full

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

    • Private numberOfRunningTasks

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

    • type

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

    • Methods

    @@ -271,14 +271,14 @@ Can be overridden.

    Returns void

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

    • Protected afterWorkerSetup

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

    • Protected beforePromiseResponseHook

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

    • Protected chooseWorker

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • destroyWorker

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

    • execute

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

    • findFreeWorkerKey

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

    • Protected internalBusy

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

    • Protected isMain

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

    • registerWorkerMessageListener

    Protected removeWorker

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

    • Protected sendToWorker

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

    • setWorkerChoiceStrategy

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:384
    • diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index 9839ac13..d263e3e9 100644 --- a/docs/classes/DynamicThreadPool.html +++ b/docs/classes/DynamicThreadPool.html @@ -42,7 +42,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    • DynamicThreadPool
    +
  • Defined in src/pools/thread/dynamic.ts:17
    • @@ -129,17 +129,17 @@ When the maximum number of threads is reached and workers are busy, an event is

    Returns DynamicThreadPool<Data, Response>

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

    • Properties

    Optional Readonly emitter

    emitter?: PoolEmitter
    -

    {@inheritDoc}

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

    • Readonly filePath

    filePath: string
    @@ -147,14 +147,14 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:67

    • Private Readonly max

    max: number

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

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

    • Readonly numberOfWorkers

    numberOfWorkers: number
    @@ -162,7 +162,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:66

    • Readonly opts

    opts: PoolOptions<ThreadWorkerWithMessageChannel>
    @@ -170,7 +170,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:68

    • Protected promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<ThreadWorkerWithMessageChannel, Response>> = ...
    @@ -183,7 +183,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:42

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<ThreadWorkerWithMessageChannel, Data, Response>
    @@ -192,15 +192,15 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:52

    • Readonly workers

    workers: WorkerType<ThreadWorkerWithMessageChannel>[] = []
    -

    {@inheritDoc}

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

    • Accessors

    @@ -208,23 +208,23 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/thread/dynamic.ts:49

    • full

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

    • Private numberOfRunningTasks

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

    • type

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

    • Methods

    @@ -271,14 +271,14 @@ Can be overridden.

    Returns void

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

    • Protected afterWorkerSetup

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

    • Protected beforePromiseResponseHook

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

    • Protected chooseWorker

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • destroyWorker

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

    • execute

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

    • findFreeWorkerKey

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

    • Protected internalBusy

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

    • Protected isMain

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

    • registerWorkerMessageListener

    Protected removeWorker

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

    • Protected sendToWorker

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

    • setWorkerChoiceStrategy

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:384
    • diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index e4905193..c39833d6 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -44,7 +44,7 @@ +
  • Defined in src/pools/cluster/fixed.ts:39
    • @@ -126,17 +126,17 @@

    Returns FixedClusterPool<Data, Response>

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

    • Properties

    Optional Readonly emitter

    emitter?: PoolEmitter
    -

    {@inheritDoc}

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

    • Readonly filePath

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

    • Readonly numberOfWorkers

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

    • Readonly opts

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

    • Protected promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<Worker, Response>> = ...
    @@ -173,7 +173,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:42

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -182,15 +182,15 @@
    +
  • Defined in src/pools/abstract-pool.ts:52

    • Readonly workers

    workers: WorkerType<Worker>[] = []
    -

    {@inheritDoc}

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

    • Accessors

    @@ -198,23 +198,23 @@
    +
  • Defined in src/pools/cluster/fixed.ts:109

    • full

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

    • Private numberOfRunningTasks

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

    • type

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

    • Methods

    @@ -261,14 +261,14 @@ Can be overridden.

    Returns void

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

    • Protected afterWorkerSetup

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

    • Protected beforePromiseResponseHook

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

    • Protected chooseWorker

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • destroyWorker

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

    • execute

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

    • findFreeWorkerKey

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

    • Protected internalBusy

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

    • Protected isMain

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

    • registerWorkerMessageListener

    Protected removeWorker

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

    • Protected sendToWorker

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

    • setWorkerChoiceStrategy

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:384
    • diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index ddd348ed..0c231359 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -44,7 +44,7 @@ +
  • Defined in src/pools/thread/fixed.ts:29
    • @@ -126,17 +126,17 @@

    Returns FixedThreadPool<Data, Response>

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

    • Properties

    Optional Readonly emitter

    emitter?: PoolEmitter
    -

    {@inheritDoc}

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

    • Readonly filePath

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

    • Readonly numberOfWorkers

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

    • Readonly opts

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

    • Protected promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<ThreadWorkerWithMessageChannel, Response>> = ...
    @@ -173,7 +173,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:42

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<ThreadWorkerWithMessageChannel, Data, Response>
    @@ -182,15 +182,15 @@
    +
  • Defined in src/pools/abstract-pool.ts:52

    • Readonly workers

    workers: WorkerType<ThreadWorkerWithMessageChannel>[] = []
    -

    {@inheritDoc}

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

    • Accessors

    @@ -198,23 +198,23 @@
    +
  • Defined in src/pools/thread/fixed.ts:105

    • full

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

    • Private numberOfRunningTasks

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

    • type

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

    • Methods

    @@ -261,14 +261,14 @@ Can be overridden.

    Returns void

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

    • Protected afterWorkerSetup

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

    • Protected beforePromiseResponseHook

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

    • Protected chooseWorker

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • destroyWorker

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

    • execute

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

    • findFreeWorkerKey

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

    • Protected internalBusy

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

    • Protected isMain

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

    • registerWorkerMessageListener

    Protected removeWorker

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

    • Protected sendToWorker

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

    • setWorkerChoiceStrategy

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:384
    • diff --git a/docs/classes/PoolEmitter.html b/docs/classes/PoolEmitter.html index f838bd2f..169355f2 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 244e4052..7f863f78 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
    • @@ -119,7 +119,7 @@ but the minimum number of workers will be guaranteed.

    Returns ThreadWorker<Data, Response>

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

    • Properties

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

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

    • Protected Readonly isMain

    isMain: boolean
    @@ -137,7 +137,7 @@ but the minimum number of workers will be guaranteed.

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

    • Protected lastTaskTimestamp

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

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

    • Protected mainWorker

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

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

    • Readonly opts

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

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

    • Methods

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

    Returns void

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

    • emitDestroy

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

    • Protected handleError

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

    • Protected messageListener

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

    • Protected run

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

    • Protected runAsync

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

    • 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_USED" | "LESS_BUSY" | "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 a071cb7c..85d72c2c 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:73

    • Optional Readonly emitter

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

    • execute

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

    Returns Promise<Response>

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

    • setWorkerChoiceStrategy

    setWorkerChoiceStrategy: ((workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN") => void)
    @@ -121,7 +121,7 @@

    Returns void

    +
  • Defined in src/pools/pool.ts:79
    • diff --git a/docs/interfaces/PoolOptions.html b/docs/interfaces/PoolOptions.html index b41b4223..0e97bcb3 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_USED" | "LESS_BUSY" | "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 ce83fd2f..10836ce8 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 a4d28996..d36c6ddd 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 6c288740..8c67147d 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 9ff45002..2b0d8c2e 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 e504042d..34198f82 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 a701ef87..86cea39d 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 8121f3ca..f5ddf5d2 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:15
    • diff --git a/docs/types/WorkerChoiceStrategy.html b/docs/types/WorkerChoiceStrategy.html index b298fff7..42caf804 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:33
    • diff --git a/docs/variables/KillBehaviors.html b/docs/variables/KillBehaviors.html index ac2deced..6d27cbf7 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 3d0d7f82..7ed027ba 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:7