From c0b0686de0f8c5483b20b94fac97d2b8175c0556 Mon Sep 17 00:00:00 2001 From: =?utf8?q?J=C3=A9r=C3=B4me=20Benoit?= Date: Sun, 9 Oct 2022 13:57:27 +0200 Subject: [PATCH] Update documentation MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Jérôme Benoit --- docs/classes/AbstractWorker.html | 30 ++++---- docs/classes/ClusterWorker.html | 26 +++---- docs/classes/DynamicClusterPool.html | 72 +++++++++---------- docs/classes/DynamicThreadPool.html | 72 +++++++++---------- docs/classes/FixedClusterPool.html | 72 +++++++++---------- docs/classes/FixedThreadPool.html | 72 +++++++++---------- docs/classes/ThreadWorker.html | 26 +++---- docs/interfaces/ClusterPoolOptions.html | 16 ++--- docs/interfaces/IPool.html | 8 +-- docs/interfaces/IPoolWorker.html | 14 ++-- 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/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, 223 insertions(+), 223 deletions(-) diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index 93d75635..825204bb 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
  • lastTaskTimestamp: number

    Timestamp of the last task processed by this worker.

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

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

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

    Returns void

    +
  • Defined in src/worker/abstract-worker.ts:144
    • @@ -238,7 +238,7 @@ the AsyncResource to which the function is bound.

      Returns Response

    Returns void

    +
  • Defined in src/worker/abstract-worker.ts:118
    • @@ -251,7 +251,7 @@ the AsyncResource to which the function is bound.

      opts: WorkerOptions

    Returns void

    +
  • Defined in src/worker/abstract-worker.ts:103
  • +
  • Defined in src/worker/abstract-worker.ts:127
    • @@ -298,7 +298,7 @@ never be called.

    Returns string

    +
  • Defined in src/worker/abstract-worker.ts:159
    • @@ -324,7 +324,7 @@ never be called.

      Returns Response

    Returns void

    +
  • Defined in src/worker/abstract-worker.ts:81
    • @@ -356,7 +356,7 @@ never be called.

    Returns void

    +
  • Defined in src/worker/abstract-worker.ts:169
    • @@ -388,7 +388,7 @@ never be called.

    Returns void

    +
  • Defined in src/worker/abstract-worker.ts:190
    • @@ -456,7 +456,7 @@ then restore the original execution context.

    Returns void

    +
  • Defined in src/worker/abstract-worker.ts:139
    • diff --git a/docs/classes/ClusterWorker.html b/docs/classes/ClusterWorker.html index ff5db753..f5c6ec9c 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
  • lastTaskTimestamp: number
    @@ -134,13 +134,13 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:27
  • mainWorker: undefined | null | Worker
    +
  • Defined in src/worker/abstract-worker.ts:49
  • @@ -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
  • +
  • Defined in src/worker/abstract-worker.ts:127
  • +
  • Defined in src/worker/cluster-worker.ts:47
  • +
  • Defined in src/worker/abstract-worker.ts:81
  • +
  • Defined in src/worker/abstract-worker.ts:169
  • +
  • Defined in src/worker/abstract-worker.ts:190
  • +
  • Defined in src/worker/cluster-worker.ts:42
    • diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 088c0bba..5e8ceb76 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
  • @@ -131,7 +131,7 @@ When the maximum number of workers is reached, an event is emitted. If you want

    Returns DynamicClusterPool<Data, Response>

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

    @@ -141,13 +141,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:36
  • filePath: string
    +
  • Defined in src/pools/abstract-pool.ts:79
  • max: number
    @@ -155,7 +155,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
  • nextMessageId: number = 0
    @@ -163,19 +163,19 @@ When the maximum number of workers is reached, an event is emitted. If you want
    +
  • Defined in src/pools/abstract-pool.ts:57
  • numberOfWorkers: number
    +
  • Defined in src/pools/abstract-pool.ts:78
  • +
  • Defined in src/pools/cluster/fixed.ts:47
  • promiseMap: Map<number, PromiseWorkerResponseWrapper<Worker, Response>> = ...
    @@ -188,7 +188,7 @@ When the maximum number of workers is reached, an event is emitted. If you want
    +
  • Defined in src/pools/abstract-pool.ts:49
  • tasks: Map<Worker, number> = ...
    @@ -196,7 +196,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
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -205,7 +205,7 @@ When the maximum number of workers is reached, an event is emitted. If you want
    +
  • Defined in src/pools/abstract-pool.ts:64
  • workers: Worker[] = []
    @@ -213,7 +213,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:30
  • Accessors

    @@ -226,7 +226,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
    • @@ -237,7 +237,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:150
    • @@ -248,7 +248,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

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

    Returns void

    +
  • Defined in src/pools/cluster/fixed.ts:89
  • +
  • Defined in src/pools/abstract-pool.ts:283
  • +
  • Defined in src/pools/abstract-pool.ts:337
  • +
  • Defined in src/pools/cluster/fixed.ts:84
  • +
  • Defined in src/pools/abstract-pool.ts:246
  • +
  • Defined in src/pools/abstract-pool.ts:208
  • +
  • Defined in src/pools/cluster/fixed.ts:65
  • +
  • Defined in src/pools/abstract-pool.ts:196
  • +
  • Defined in src/pools/abstract-pool.ts:185
  • +
  • Defined in src/pools/abstract-pool.ts:160
  • +
  • Defined in src/pools/abstract-pool.ts:155
  • +
  • Defined in src/pools/abstract-pool.ts:237
  • +
  • Defined in src/pools/abstract-pool.ts:308
  • +
  • Defined in src/pools/abstract-pool.ts:177
  • +
  • Defined in src/pools/cluster/fixed.ts:60
  • +
  • Defined in src/pools/cluster/fixed.ts:76
  • +
  • Defined in src/pools/abstract-pool.ts:270
  • +
  • Defined in src/pools/cluster/fixed.ts:71
  • +
  • Defined in src/pools/abstract-pool.ts:165
  • +
  • Defined in src/pools/cluster/fixed.ts:53
    • @@ -587,7 +587,7 @@ When the maximum number of workers is reached, an event is emitted. If you want

      Returns void

    +
  • Defined in src/pools/abstract-pool.ts:361
  • +
  • Defined in src/pools/thread/dynamic.ts:31
  • nextMessageId: number = 0
    @@ -163,19 +163,19 @@ When the maximum number of threads is reached, an event is emitted. If you want
    +
  • Defined in src/pools/abstract-pool.ts:57
  • numberOfWorkers: number
    +
  • Defined in src/pools/abstract-pool.ts:78
  • +
  • Defined in src/pools/abstract-pool.ts:80
  • promiseMap: Map<number, PromiseWorkerResponseWrapper<ThreadWorkerWithMessageChannel, Response>> = ...
    @@ -188,7 +188,7 @@ When the maximum number of threads is reached, an event is emitted. If you want
    +
  • Defined in src/pools/abstract-pool.ts:49
  • tasks: Map<ThreadWorkerWithMessageChannel, number> = ...
    @@ -196,7 +196,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
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<ThreadWorkerWithMessageChannel, Data, Response>
    @@ -205,7 +205,7 @@ When the maximum number of threads is reached, an event is emitted. If you want
    +
  • Defined in src/pools/abstract-pool.ts:64
  • @@ -213,7 +213,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:30
  • Accessors

    @@ -226,7 +226,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
    • @@ -237,7 +237,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:150
    • @@ -248,7 +248,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

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

    Returns void

    +
  • Defined in src/pools/thread/fixed.ts:80
  • +
  • Defined in src/pools/abstract-pool.ts:283
  • +
  • Defined in src/pools/abstract-pool.ts:337
  • +
  • Defined in src/pools/thread/fixed.ts:73
  • +
  • Defined in src/pools/abstract-pool.ts:246
  • +
  • Defined in src/pools/abstract-pool.ts:208
  • +
  • Defined in src/pools/thread/fixed.ts:49
  • +
  • Defined in src/pools/abstract-pool.ts:196
  • +
  • Defined in src/pools/abstract-pool.ts:185
  • +
  • Defined in src/pools/abstract-pool.ts:160
  • +
  • Defined in src/pools/abstract-pool.ts:155
  • +
  • Defined in src/pools/abstract-pool.ts:237
  • +
  • Defined in src/pools/abstract-pool.ts:308
  • +
  • Defined in src/pools/abstract-pool.ts:177
  • +
  • Defined in src/pools/thread/fixed.ts:44
  • +
  • Defined in src/pools/thread/fixed.ts:65
  • +
  • Defined in src/pools/abstract-pool.ts:270
  • +
  • Defined in src/pools/thread/fixed.ts:57
  • +
  • Defined in src/pools/abstract-pool.ts:165
  • +
  • Defined in src/pools/abstract-pool.ts:223
    • @@ -588,7 +588,7 @@ to run code before workers are created in the abstract constructor.

      Returns void

    +
  • Defined in src/pools/abstract-pool.ts:361
  • +
  • Defined in src/pools/abstract-pool.ts:39
  • nextMessageId: number = 0
    @@ -161,19 +161,19 @@
    +
  • Defined in src/pools/abstract-pool.ts:57
  • numberOfWorkers: number
    +
  • Defined in src/pools/abstract-pool.ts:78
  • +
  • Defined in src/pools/cluster/fixed.ts:47
  • promiseMap: Map<number, PromiseWorkerResponseWrapper<Worker, Response>> = ...
    @@ -186,7 +186,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:49
  • tasks: Map<Worker, number> = ...
    @@ -194,7 +194,7 @@

    Inherit Doc

    +
  • Defined in src/pools/abstract-pool.ts:33
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -203,7 +203,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:64
  • workers: Worker[] = []
    @@ -211,7 +211,7 @@

    Inherit Doc

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

    @@ -224,7 +224,7 @@

    Returns boolean

    +
  • Defined in src/pools/cluster/fixed.ts:100
  • +
  • Defined in src/pools/abstract-pool.ts:150
  • +
  • Defined in src/pools/cluster/fixed.ts:95
  • Methods

    @@ -264,7 +264,7 @@

    Returns void

    +
  • Defined in src/pools/cluster/fixed.ts:89
  • +
  • Defined in src/pools/abstract-pool.ts:283
  • +
  • Defined in src/pools/abstract-pool.ts:337
  • +
  • Defined in src/pools/cluster/fixed.ts:84
  • +
  • Defined in src/pools/abstract-pool.ts:246
  • +
  • Defined in src/pools/abstract-pool.ts:208
  • +
  • Defined in src/pools/cluster/fixed.ts:65
  • +
  • Defined in src/pools/abstract-pool.ts:196
  • +
  • Defined in src/pools/abstract-pool.ts:185
  • +
  • Defined in src/pools/abstract-pool.ts:160
  • +
  • Defined in src/pools/abstract-pool.ts:155
  • +
  • Defined in src/pools/abstract-pool.ts:237
  • +
  • Defined in src/pools/abstract-pool.ts:308
  • +
  • Defined in src/pools/abstract-pool.ts:177
  • +
  • Defined in src/pools/cluster/fixed.ts:60
  • +
  • Defined in src/pools/cluster/fixed.ts:76
  • +
  • Defined in src/pools/abstract-pool.ts:270
  • +
  • Defined in src/pools/cluster/fixed.ts:71
  • +
  • Defined in src/pools/abstract-pool.ts:165
  • +
  • Defined in src/pools/cluster/fixed.ts:53
    • @@ -585,7 +585,7 @@

      Returns void

    +
  • Defined in src/pools/abstract-pool.ts:361
  • +
  • Defined in src/pools/abstract-pool.ts:39
  • nextMessageId: number = 0
    @@ -161,19 +161,19 @@
    +
  • Defined in src/pools/abstract-pool.ts:57
  • numberOfWorkers: number
    +
  • Defined in src/pools/abstract-pool.ts:78
  • +
  • Defined in src/pools/abstract-pool.ts:80
  • promiseMap: Map<number, PromiseWorkerResponseWrapper<ThreadWorkerWithMessageChannel, Response>> = ...
    @@ -186,7 +186,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:49
  • tasks: Map<ThreadWorkerWithMessageChannel, number> = ...
    @@ -194,7 +194,7 @@

    Inherit Doc

    +
  • Defined in src/pools/abstract-pool.ts:33
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<ThreadWorkerWithMessageChannel, Data, Response>
    @@ -203,7 +203,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:64
  • @@ -211,7 +211,7 @@

    Inherit Doc

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

    @@ -224,7 +224,7 @@

    Returns boolean

    +
  • Defined in src/pools/thread/fixed.ts:95
  • +
  • Defined in src/pools/abstract-pool.ts:150
  • +
  • Defined in src/pools/thread/fixed.ts:90
  • Methods

    @@ -264,7 +264,7 @@

    Returns void

    +
  • Defined in src/pools/thread/fixed.ts:80
  • +
  • Defined in src/pools/abstract-pool.ts:283
  • +
  • Defined in src/pools/abstract-pool.ts:337
  • +
  • Defined in src/pools/thread/fixed.ts:73
  • +
  • Defined in src/pools/abstract-pool.ts:246
  • +
  • Defined in src/pools/abstract-pool.ts:208
  • +
  • Defined in src/pools/thread/fixed.ts:49
  • +
  • Defined in src/pools/abstract-pool.ts:196
  • +
  • Defined in src/pools/abstract-pool.ts:185
  • +
  • Defined in src/pools/abstract-pool.ts:160
  • +
  • Defined in src/pools/abstract-pool.ts:155
  • +
  • Defined in src/pools/abstract-pool.ts:237
  • +
  • Defined in src/pools/abstract-pool.ts:308
  • +
  • Defined in src/pools/abstract-pool.ts:177
  • +
  • Defined in src/pools/thread/fixed.ts:44
  • +
  • Defined in src/pools/thread/fixed.ts:65
  • +
  • Defined in src/pools/abstract-pool.ts:270
  • +
  • Defined in src/pools/thread/fixed.ts:57
  • +
  • Defined in src/pools/abstract-pool.ts:165
    • @@ -558,7 +558,7 @@ to run code before workers are created in the abstract constructor.

      Returns void

    +
  • Defined in src/pools/abstract-pool.ts:223
    • @@ -586,7 +586,7 @@ to run code before workers are created in the abstract constructor.

      Returns void

    +
  • Defined in src/pools/abstract-pool.ts:361
  • +
  • Defined in src/worker/abstract-worker.ts:27
  • mainWorker: undefined | null | MessagePort
    +
  • Defined in src/worker/abstract-worker.ts:49
  • @@ -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
  • +
  • Defined in src/worker/abstract-worker.ts:127
  • +
  • Defined in src/worker/abstract-worker.ts:159
  • +
  • Defined in src/worker/abstract-worker.ts:81
  • +
  • Defined in src/worker/abstract-worker.ts:169
  • +
  • Defined in src/worker/abstract-worker.ts:190
  • +
  • Defined in src/worker/thread-worker.ts:36
    • diff --git a/docs/interfaces/ClusterPoolOptions.html b/docs/interfaces/ClusterPoolOptions.html index c3505bde..b0b4e127 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
  • 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
  • errorHandler?: ErrorHandler<Worker>
    @@ -67,7 +67,7 @@
    +
  • Defined in src/pools/pool.ts:20
  • exitHandler?: ExitHandler<Worker>
    @@ -75,7 +75,7 @@
    +
  • Defined in src/pools/pool.ts:28
  • messageHandler?: MessageHandler<Worker>
    @@ -83,7 +83,7 @@
    +
  • Defined in src/pools/pool.ts:16
  • onlineHandler?: OnlineHandler<Worker>
    @@ -91,7 +91,7 @@
    +
  • Defined in src/pools/pool.ts:24
  • workerChoiceStrategy?: "ROUND_ROBIN" | "LESS_RECENTLY_USED"
    @@ -99,7 +99,7 @@
    +
  • Defined in src/pools/pool.ts:32
  • Returns Promise<Response>

    +
  • Defined in src/pools/pool.ts:54
    • @@ -91,7 +91,7 @@

    Returns void

    +
  • Defined in src/pools/pool.ts:64
  • Returns void

    +
  • Defined in src/pools/pool-worker.ts:44
  • Register a listener to the error event.

    @@ -85,7 +85,7 @@
  • Returns void

    +
  • Defined in src/pools/pool-worker.ts:51
  • Register a listener to the online event.

    @@ -103,7 +103,7 @@
  • Returns void

    +
  • Defined in src/pools/pool-worker.ts:58
  • Register a listener to the exit event.

    @@ -121,7 +121,7 @@
  • Returns void

    +
  • Defined in src/pools/pool-worker.ts:65
    • @@ -142,7 +142,7 @@

    Returns void

    +
  • Defined in src/pools/pool-worker.ts:72
  • +
  • Defined in src/pools/pool.ts:32
  • +
  • Defined in src/worker/worker-options.ts:68
  • maxInactiveTime?: number
    @@ -73,7 +73,7 @@ when this timeout expires your tasks is interrupted and the worker is killed if

    Default

    60.000 ms

    +
  • Defined in src/worker/worker-options.ts:51
  • +
  • Defined in src/pools/pool-worker.ts:18
  • +
  • Defined in src/pools/pool-worker.ts:28
  • +
  • Defined in src/pools/pool-worker.ts:23