From: Jérôme Benoit Date: Sat, 15 Oct 2022 05:37:24 +0000 (+0200) Subject: Update API documentation X-Git-Tag: v2.3.2~3^2 X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=301c53e7ae6cf1120298ea10868a9091904c01a2;p=poolifier.git Update API documentation Signed-off-by: Jérôme Benoit --- diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index c048f6f6..88a908c3 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -41,7 +41,7 @@
  • ClusterWorker
  • ThreadWorker
    • +
  • Defined in src/worker/abstract-worker.ts:19
    • @@ -131,7 +131,7 @@

    Returns AbstractWorker<MainWorker, Data, Response>

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

    • Properties

    @@ -140,26 +140,26 @@

    Handler Id of the aliveInterval worker alive check.

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

    • Protected lastTaskTimestamp

    lastTaskTimestamp: number

    Timestamp of the last task processed by this worker.

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

    • Protected mainWorker

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

    • Readonly opts

    opts: WorkerOptions

    Options for the worker.

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

    • Methods

    @@ -210,13 +210,13 @@ the AsyncResource to which the function is bound.

    Returns void

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

    • Private checkFunctionInput

    • -

      Check if the fn parameter is passed to the constructor.

      +

      Checks if the fn parameter is passed to the constructor.

      Parameters

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

      Returns Response

    Returns void

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

    • Private checkWorkerOptions

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

      opts: WorkerOptions

    Returns void

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

    • emitDestroy

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

    • Protected handleError

    • -

      Handle an error and convert it to a string so it can be sent back to the main worker.

      +

      Handles an error and convert it to a string so it can be sent back to the main worker.

      Returns

      Message of the error.

      @@ -298,7 +298,7 @@ never be called.

    Returns string

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

    • Protected messageListener

      @@ -324,13 +324,13 @@ never be called.

      Returns Response

    Returns void

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

    • Protected run

    • -

      Run the given function synchronously.

      +

      Runs the given function synchronously.

      Parameters

      @@ -356,13 +356,13 @@ never be called.

    Returns void

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

    • Protected runAsync

    • -

      Run the given function asynchronously.

      +

      Runs the given function asynchronously.

      Parameters

      @@ -388,7 +388,7 @@ never be called.

    Returns void

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

    • runInAsyncScope

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

      • -

        Send a message to the main worker.

        +

        Sends a message to the main worker.

        Parameters

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

      Returns void

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

    • triggerAsyncId

      diff --git a/docs/classes/ClusterWorker.html b/docs/classes/ClusterWorker.html index 53205cf2..22d28163 100644 --- a/docs/classes/ClusterWorker.html +++ b/docs/classes/ClusterWorker.html @@ -42,7 +42,7 @@ but the minimum number of workers will be guaranteed.

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

    Returns ClusterWorker<Data, Response>

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

    • Properties

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

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

    • Protected lastTaskTimestamp

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

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

    • Protected mainWorker

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

    • Readonly opts

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

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

    • Methods

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

    • -

      Handle an error and convert it to a string so it can be sent back to the main worker.

      +

      Handles an error and convert it to a string so it can be sent back to the main worker.

      Returns

      Message of the error.

      @@ -249,7 +249,7 @@ never be called.

      Returns string

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

    • Protected messageListener

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

    • Protected run

    • -

      Run the given function synchronously.

      +

      Runs the given function synchronously.

      Parameters

      @@ -309,13 +309,13 @@ never be called.

      Returns void

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

    • Protected runAsync

    • -

      Run the given function asynchronously.

      +

      Runs the given function asynchronously.

      Parameters

      @@ -342,7 +342,7 @@ never be called.

      Returns void

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

    • runInAsyncScope

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

      • -

        Send a message to the main worker.

        +

        Sends a message to the main worker.

        Parameters

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

        Returns void

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

    • triggerAsyncId

      diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 051f7ce5..9fa48bd1 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -40,7 +40,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
    • @@ -100,7 +100,7 @@ When the maximum number of workers is reached, an event is emitted. If you want

    constructor

      - +

    • Constructs a new poolifier dynamic cluster pool.

      @@ -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.

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

      Options for this dynamic cluster pool.

    Returns DynamicClusterPool<Data, Response>

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

    • Properties

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

    Inherit Doc

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

    • Readonly filePath

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

    • Readonly max

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

    Inherit Doc

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

    • Protected nextMessageId

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

    • Readonly numberOfWorkers

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

    • Readonly opts

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

    • Protected promiseMap

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

    • Protected workerChoiceStrategyContext

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

    • Readonly workers

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

    Inherit Doc

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

    • Readonly workersTasksUsage

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

    Inherit Doc

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

    • Accessors

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

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

      Returns number

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

    • type

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

      Returns PoolType

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

    • Methods

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

    Returns void

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

    • Protected afterWorkerSetup

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

    • Protected beforePromiseWorkerResponseHook

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

    • Protected chooseWorker

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • destroyWorker

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

    • execute

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

    • findFreeWorker

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

    • getWorkerAverageTasksRunTime

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

    • getWorkerIndex

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

    • getWorkerRunningTasks

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

    • initWorkerTasksUsage

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

    • Protected internalExecute

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

    • Protected internalGetBusyStatus

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

    • Protected isMain

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

    • registerWorkerMessageListener

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

    • Protected removeWorker

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

    • Protected sendToWorker

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

    • setWorkerChoiceStrategy

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

    • Protected setupHook

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

    • Protected workerListener

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

      Returns void

    +
  • Defined in src/pools/abstract-pool.ts:368
    • diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index fa708b4b..986df615 100644 --- a/docs/classes/DynamicThreadPool.html +++ b/docs/classes/DynamicThreadPool.html @@ -40,7 +40,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
    • @@ -100,7 +100,7 @@ When the maximum number of threads is reached, an event is emitted. If you want

    constructor

    Returns DynamicThreadPool<Data, Response>

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

    • Properties

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

    Inherit Doc

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

    • Readonly filePath

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

    • Readonly max

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

    Inherit Doc

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

    • Protected nextMessageId

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

    • Readonly numberOfWorkers

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

    • Readonly opts

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

    • Protected promiseMap

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

    • Protected workerChoiceStrategyContext

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

    • Readonly workers

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

    Inherit Doc

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

    • Readonly workersTasksUsage

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

    Inherit Doc

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

    • Accessors

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

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

      Returns number

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

    • type

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

      Returns PoolType

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

    • Methods

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

    Returns void

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

    • Protected afterWorkerSetup

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

    • Protected beforePromiseWorkerResponseHook

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

    • Protected chooseWorker

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • destroyWorker

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

    • execute

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

    • findFreeWorker

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

    • getWorkerAverageTasksRunTime

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

    • getWorkerIndex

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

    • getWorkerRunningTasks

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

    • initWorkerTasksUsage

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

    • Protected internalExecute

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

    • Protected internalGetBusyStatus

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

    • Protected isMain

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

    • registerWorkerMessageListener

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

    • Protected removeWorker

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

    • Protected sendToWorker

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

    • setWorkerChoiceStrategy

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

    • Protected setupHook

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

    • Protected workerListener

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

      Returns void

    +
  • Defined in src/pools/abstract-pool.ts:368
    • diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 5e4adf05..b6a1b722 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -42,7 +42,7 @@ +
  • Defined in src/pools/cluster/fixed.ts:33
    • @@ -102,7 +102,7 @@

    constructor

      - +

    • Constructs a new poolifier fixed cluster pool.

      @@ -125,13 +125,13 @@

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

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

      Options for this fixed cluster pool.

    Returns FixedClusterPool<Data, Response>

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

    • Properties

    @@ -141,13 +141,13 @@

    Inherit Doc

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

    • Readonly filePath

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

    • Optional Readonly max

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

    Inherit Doc

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

    • Protected nextMessageId

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

    • Readonly numberOfWorkers

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

    • Readonly opts

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

    • Protected promiseMap

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

    • Protected workerChoiceStrategyContext

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

    • Readonly workers

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

    Inherit Doc

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

    • Readonly workersTasksUsage

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

    Inherit Doc

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

    • Accessors

    @@ -226,7 +226,7 @@

    Returns boolean

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

    • numberOfRunningTasks

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

    • type

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

    • Methods

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

    Returns void

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

    • Protected afterWorkerSetup

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

    • Protected beforePromiseWorkerResponseHook

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

      Returns void

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

    • Protected chooseWorker

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • destroyWorker

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

    • execute

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

    • findFreeWorker

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

    • getWorkerAverageTasksRunTime

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

      Returns undefined | number

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

    • getWorkerIndex

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

    • getWorkerRunningTasks

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

      Returns undefined | number

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

    • initWorkerTasksUsage

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

    • Protected internalExecute

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

      Returns Promise<Response>

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

    • Protected internalGetBusyStatus

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

    • Protected isMain

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

    • registerWorkerMessageListener

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

      Returns void

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

    • Protected removeWorker

      @@ -549,12 +549,12 @@ Can be overridden.

      • worker: Worker
        -

        Worker that will be removed.

        +

        The worker that will be removed.

      Returns void

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

    • Protected sendToWorker

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

    • setWorkerChoiceStrategy

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

    • Protected setupHook

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

    • Protected workerListener

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

      Returns void

    +
  • Defined in src/pools/abstract-pool.ts:368
    • diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index 96a801b3..88df603a 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -42,7 +42,7 @@ +
  • Defined in src/pools/thread/fixed.ts:24
    • @@ -102,7 +102,7 @@

    constructor

    Returns FixedThreadPool<Data, Response>

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

    • Properties

    @@ -141,13 +141,13 @@

    Inherit Doc

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

    • Readonly filePath

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

    • Optional Readonly max

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

    Inherit Doc

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

    • Protected nextMessageId

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

    • Readonly numberOfWorkers

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

    • Readonly opts

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

    • Protected promiseMap

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

    • Protected workerChoiceStrategyContext

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

    • Readonly workers

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

    Inherit Doc

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

    • Readonly workersTasksUsage

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

    Inherit Doc

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

    • Accessors

    @@ -226,7 +226,7 @@

    Returns boolean

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

    • numberOfRunningTasks

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

    • type

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

    • Methods

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

    Returns void

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

    • Protected afterWorkerSetup

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

    • Protected beforePromiseWorkerResponseHook

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

      Returns void

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

    • Protected chooseWorker

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • destroyWorker

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

    • execute

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

    • findFreeWorker

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

    • getWorkerAverageTasksRunTime

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

      Returns undefined | number

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

    • getWorkerIndex

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

    • getWorkerRunningTasks

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

      Returns undefined | number

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

    • initWorkerTasksUsage

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

    • Protected internalExecute

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

      Returns Promise<Response>

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

    • Protected internalGetBusyStatus

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

    • Protected isMain

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

    • registerWorkerMessageListener

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

      Returns void

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

    • Protected removeWorker

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

    • Protected sendToWorker

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

    • setWorkerChoiceStrategy

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

    • Protected setupHook

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

      Returns void

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

    • Protected workerListener

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

      Returns void

    +
  • Defined in src/pools/abstract-pool.ts:368
    • diff --git a/docs/classes/ThreadWorker.html b/docs/classes/ThreadWorker.html index a4c0ee80..5d7373df 100644 --- a/docs/classes/ThreadWorker.html +++ b/docs/classes/ThreadWorker.html @@ -42,7 +42,7 @@ but the minimum number of workers will be guaranteed.

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

    Returns ThreadWorker<Data, Response>

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

    • Properties

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

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

    • Protected lastTaskTimestamp

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

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

    • Protected mainWorker

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

    • Readonly opts

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

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

    • Methods

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

    • -

      Handle an error and convert it to a string so it can be sent back to the main worker.

      +

      Handles an error and convert it to a string so it can be sent back to the main worker.

      Returns

      Message of the error.

      @@ -249,7 +249,7 @@ never be called.

      Returns string

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

    • Protected messageListener

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

    • Protected run

    • -

      Run the given function synchronously.

      +

      Runs the given function synchronously.

      Parameters

      @@ -309,13 +309,13 @@ never be called.

      Returns void

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

    • Protected runAsync

    • -

      Run the given function asynchronously.

      +

      Runs the given function asynchronously.

      Parameters

      @@ -342,7 +342,7 @@ never be called.

      Returns void

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

    • runInAsyncScope

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

      • -

        Send a message to the main worker.

        +

        Sends a message to the main worker.

        Parameters

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

        Returns void

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

    • triggerAsyncId

      diff --git a/docs/interfaces/ClusterPoolOptions.html b/docs/interfaces/ClusterPoolOptions.html index 6adf2513..20363fac 100644 --- a/docs/interfaces/ClusterPoolOptions.html +++ b/docs/interfaces/ClusterPoolOptions.html @@ -23,7 +23,7 @@
      • ClusterPoolOptions
    +
  • Defined in src/pools/cluster/fixed.ts:11
    • @@ -50,7 +50,7 @@
    +
  • Defined in src/pools/pool.ts:38

    • Optional env

    env?: any
    @@ -59,7 +59,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>
    @@ -67,7 +67,7 @@
    +
  • Defined in src/pools/pool.ts:20

    • Optional exitHandler

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

    • Optional messageHandler

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

    • Optional onlineHandler

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

    • Optional workerChoiceStrategy

    workerChoiceStrategy?: "ROUND_ROBIN" | "LESS_RECENTLY_USED" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
    @@ -99,7 +99,7 @@
    +
  • Defined in src/pools/pool.ts:32
    • diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 39bf3862..d8d8c103 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -32,7 +32,7 @@
    • IPool
    +
  • Defined in src/pools/pool.ts:47
    • @@ -55,7 +55,7 @@

    Returns Promise<void>

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

    • execute

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

    Returns Promise<Response>

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

    • setWorkerChoiceStrategy

      @@ -91,7 +91,7 @@

    Returns void

    +
  • Defined in src/pools/pool.ts:64
    • diff --git a/docs/interfaces/IPoolWorker.html b/docs/interfaces/IPoolWorker.html index aaf054a0..9542216a 100644 --- a/docs/interfaces/IPoolWorker.html +++ b/docs/interfaces/IPoolWorker.html @@ -21,7 +21,7 @@
    • IPoolWorker
    +
  • Defined in src/pools/pool-worker.ts:33
    • @@ -54,7 +54,7 @@

    Returns void

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

  • Register a listener to the error event.

    @@ -72,7 +72,7 @@

    • Returns void

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

  • Register a listener to the online event.

    @@ -90,7 +90,7 @@

    • Returns void

    +
  • Defined in src/pools/pool-worker.ts:54

  • Register a listener to the exit event.

    @@ -108,7 +108,7 @@

    • Returns void

    +
  • Defined in src/pools/pool-worker.ts:61

    • once

      @@ -129,7 +129,7 @@

    Returns void

    +
  • Defined in src/pools/pool-worker.ts:68
    • diff --git a/docs/interfaces/PoolOptions.html b/docs/interfaces/PoolOptions.html index 45d14b60..b3e10e06 100644 --- a/docs/interfaces/PoolOptions.html +++ b/docs/interfaces/PoolOptions.html @@ -28,7 +28,7 @@ +
  • Defined in src/pools/pool.ts:12
    • @@ -53,42 +53,42 @@

    Default

    true

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

    • Optional errorHandler

    errorHandler?: ErrorHandler<Worker>

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

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

    • Optional exitHandler

    exitHandler?: ExitHandler<Worker>

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

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

    • Optional messageHandler

    messageHandler?: MessageHandler<Worker>

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

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

    • Optional onlineHandler

    onlineHandler?: OnlineHandler<Worker>

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

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

    • 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:32
    • diff --git a/docs/interfaces/WorkerOptions.html b/docs/interfaces/WorkerOptions.html index 446b46f6..718a8308 100644 --- a/docs/interfaces/WorkerOptions.html +++ b/docs/interfaces/WorkerOptions.html @@ -21,7 +21,7 @@
    • WorkerOptions
    +
  • Defined in src/worker/worker-options.ts:38
    • @@ -43,7 +43,7 @@

    Default

    false

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

    • Optional killBehavior

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

    Default

    KillBehaviors.SOFT

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

    • Optional maxInactiveTime

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

    Default

    60000 ms

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

    Returns void

    +
  • Defined in src/pools/pool-worker.ts:18
    • diff --git a/docs/types/ExitHandler.html b/docs/types/ExitHandler.html index b023089e..04e11665 100644 --- a/docs/types/ExitHandler.html +++ b/docs/types/ExitHandler.html @@ -37,7 +37,7 @@
    code: number

    Returns void

    +
  • Defined in src/pools/pool-worker.ts:28
    • diff --git a/docs/types/KillBehavior.html b/docs/types/KillBehavior.html index 6fe0df76..cdca90d0 100644 --- a/docs/types/KillBehavior.html +++ b/docs/types/KillBehavior.html @@ -17,7 +17,7 @@

    Kill behavior.

    +
  • Defined in src/worker/worker-options.ts:18
    • diff --git a/docs/types/MessageHandler.html b/docs/types/MessageHandler.html index 7797a283..766ec9b2 100644 --- a/docs/types/MessageHandler.html +++ b/docs/types/MessageHandler.html @@ -37,7 +37,7 @@
    m: unknown

    Returns void

    +
  • Defined in src/pools/pool-worker.ts:13
    • diff --git a/docs/types/OnlineHandler.html b/docs/types/OnlineHandler.html index 653b553d..4f91e827 100644 --- a/docs/types/OnlineHandler.html +++ b/docs/types/OnlineHandler.html @@ -35,7 +35,7 @@
    this: Worker

    Returns void

    +
  • Defined in src/pools/pool-worker.ts:23
    • diff --git a/docs/types/ThreadWorkerWithMessageChannel.html b/docs/types/ThreadWorkerWithMessageChannel.html index b7a5c0f0..5db27bfc 100644 --- a/docs/types/ThreadWorkerWithMessageChannel.html +++ b/docs/types/ThreadWorkerWithMessageChannel.html @@ -17,7 +17,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 45393f47..282f4410 100644 --- a/docs/types/WorkerChoiceStrategy.html +++ b/docs/types/WorkerChoiceStrategy.html @@ -17,7 +17,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 950cf175..d007a00c 100644 --- a/docs/variables/KillBehaviors.html +++ b/docs/variables/KillBehaviors.html @@ -17,7 +17,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 e68f87c6..77ea2170 100644 --- a/docs/variables/WorkerChoiceStrategies.html +++ b/docs/variables/WorkerChoiceStrategies.html @@ -17,7 +17,7 @@

    Enumeration of worker choice strategies.

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