From: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Date: Sat, 1 Apr 2023 20:26:35 +0000 (+0000) Subject: chore: generate documentation X-Git-Tag: v2.4.0-0~20^2 X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=e1230e386080ae19766e2a7863c807a90f13a3ef;p=poolifier.git chore: generate documentation --- diff --git a/docs/classes/ClusterWorker.html b/docs/classes/ClusterWorker.html index ae4fe016..770c6edb 100644 --- a/docs/classes/ClusterWorker.html +++ b/docs/classes/ClusterWorker.html @@ -44,7 +44,7 @@ but the minimum number of workers will be guaranteed.

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

    Returns ClusterWorker<Data, Response>

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

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

    +
  • Defined in src/worker/abstract-worker.ts:35
  • lastTaskTimestamp: number
    @@ -136,7 +136,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:31
  • mainWorker: undefined | null | Worker
    @@ -144,7 +144,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:53
  • opts: WorkerOptions
    @@ -152,7 +152,7 @@ but the minimum number of workers will be guaranteed.

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

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

    Returns number

    +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:315
  • +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:288
  • +
  • Defined in src/worker/abstract-worker.ts:147
  • +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:311
  • +
  • Defined in src/worker/abstract-worker.ts:130
  • +
  • Defined in src/worker/cluster-worker.ts:47
  • +
  • Defined in src/worker/abstract-worker.ts:84
  • +
  • Defined in src/worker/abstract-worker.ts:172
  • +
  • Defined in src/worker/abstract-worker.ts:196
  • +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:303
  • +
  • Defined in src/worker/cluster-worker.ts:42
  • +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:320
  • +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:273
  • +
  • Defined in src/pools/abstract-pool.ts:80
  • max: number

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

    +
  • Defined in src/pools/cluster/dynamic.ts:30
  • 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
  • numberOfWorkers: number
    @@ -174,7 +174,7 @@ When the maximum number of workers is reached, an event is emitted. If you want
    +
  • Defined in src/pools/abstract-pool.ts:79
  • opts: ClusterPoolOptions = {}
    @@ -182,7 +182,7 @@ When the maximum number of workers is reached, an event is emitted. If you want
    +
  • Defined in src/pools/cluster/fixed.ts:53
  • 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
  • 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
  • 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
  • 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
  • +
  • Defined in src/pools/abstract-pool.ts:151
  • +
  • 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
  • +
  • Defined in src/pools/cluster/fixed.ts:93
  • +
  • Defined in src/pools/abstract-pool.ts:255
  • +
  • Defined in src/pools/abstract-pool.ts:293
  • +
  • Defined in src/pools/abstract-pool.ts:337
  • +
  • Defined in src/pools/cluster/fixed.ts:88
  • +
  • Defined in src/pools/abstract-pool.ts:221
  • +
  • Defined in src/pools/cluster/fixed.ts:69
  • +
  • Defined in src/pools/abstract-pool.ts:205
  • +
  • Defined in src/pools/abstract-pool.ts:194
  • +
  • Defined in src/pools/abstract-pool.ts:166
  • +
  • Defined in src/pools/abstract-pool.ts:156
  • +
  • Defined in src/pools/abstract-pool.ts:161
  • +
  • Defined in src/pools/abstract-pool.ts:186
  • +
  • Defined in src/pools/cluster/fixed.ts:64
  • +
  • Defined in src/pools/cluster/fixed.ts:80
  • +
  • Defined in src/pools/abstract-pool.ts:280
  • +
  • Defined in src/pools/cluster/fixed.ts:75
  • +
  • Defined in src/pools/abstract-pool.ts:171
  • +
  • Defined in src/pools/cluster/fixed.ts:59
  • +
  • Defined in src/pools/abstract-pool.ts:363
  • +
  • Defined in src/pools/abstract-pool.ts:80
  • max: number

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

    +
  • Defined in src/pools/thread/dynamic.ts:31
  • 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
  • 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
  • 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
  • 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
  • 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
  • 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
  • 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
  • +
  • Defined in src/pools/abstract-pool.ts:151
  • +
  • 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
  • +
  • Defined in src/pools/thread/fixed.ts:80
  • +
  • Defined in src/pools/abstract-pool.ts:255
  • +
  • Defined in src/pools/abstract-pool.ts:293
  • +
  • Defined in src/pools/abstract-pool.ts:337
  • +
  • Defined in src/pools/thread/fixed.ts:73
  • +
  • Defined in src/pools/abstract-pool.ts:221
  • +
  • Defined in src/pools/thread/fixed.ts:49
  • +
  • Defined in src/pools/abstract-pool.ts:205
  • +
  • Defined in src/pools/abstract-pool.ts:194
  • +
  • Defined in src/pools/abstract-pool.ts:166
  • +
  • Defined in src/pools/abstract-pool.ts:156
  • +
  • Defined in src/pools/abstract-pool.ts:161
  • +
  • Defined in src/pools/abstract-pool.ts:186
  • +
  • Defined in src/pools/thread/fixed.ts:44
  • +
  • Defined in src/pools/thread/fixed.ts:65
  • +
  • Defined in src/pools/abstract-pool.ts:280
  • +
  • Defined in src/pools/thread/fixed.ts:57
  • +
  • Defined in src/pools/abstract-pool.ts:171
  • +
  • Defined in src/pools/abstract-pool.ts:240
  • +
  • Defined in src/pools/abstract-pool.ts:363
  • +
  • Defined in src/pools/abstract-pool.ts:80
  • nextMessageId: number = 0
    @@ -156,7 +156,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:58
  • numberOfWorkers: number
    @@ -164,7 +164,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:79
  • opts: ClusterPoolOptions = {}
    @@ -172,7 +172,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:53
  • promiseMap: Map<number, PromiseWorkerResponseWrapper<Worker, Response>> = ...
    @@ -185,7 +185,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:50
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -194,7 +194,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:65
  • workers: Worker[] = []
    @@ -202,7 +202,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:31
  • 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
  • +
  • Defined in src/pools/abstract-pool.ts:151
  • +
  • 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
  • +
  • Defined in src/pools/cluster/fixed.ts:93
  • +
  • Defined in src/pools/abstract-pool.ts:255
  • +
  • Defined in src/pools/abstract-pool.ts:293
  • +
  • Defined in src/pools/abstract-pool.ts:337
  • +
  • Defined in src/pools/cluster/fixed.ts:88
  • +
  • Defined in src/pools/abstract-pool.ts:221
  • +
  • Defined in src/pools/cluster/fixed.ts:69
  • +
  • Defined in src/pools/abstract-pool.ts:205
  • +
  • Defined in src/pools/abstract-pool.ts:194
  • +
  • Defined in src/pools/abstract-pool.ts:166
  • +
  • Defined in src/pools/abstract-pool.ts:156
  • +
  • Defined in src/pools/abstract-pool.ts:161
  • +
  • Defined in src/pools/abstract-pool.ts:186
  • +
  • Defined in src/pools/cluster/fixed.ts:64
  • +
  • Defined in src/pools/cluster/fixed.ts:80
  • +
  • Defined in src/pools/abstract-pool.ts:280
  • +
  • Defined in src/pools/cluster/fixed.ts:75
  • +
  • Defined in src/pools/abstract-pool.ts:171
  • +
  • Defined in src/pools/cluster/fixed.ts:59
  • +
  • Defined in src/pools/abstract-pool.ts:363
  • +
  • Defined in src/pools/abstract-pool.ts:80
  • nextMessageId: number = 0
    @@ -156,7 +156,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:58
  • numberOfWorkers: number
    @@ -164,7 +164,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:79
  • opts: PoolOptions<ThreadWorkerWithMessageChannel>
    @@ -172,7 +172,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:81
  • promiseMap: Map<number, PromiseWorkerResponseWrapper<ThreadWorkerWithMessageChannel, Response>> = ...
    @@ -185,7 +185,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:50
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<ThreadWorkerWithMessageChannel, Data, Response>
    @@ -194,7 +194,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:65
  • workers: ThreadWorkerWithMessageChannel[] = []
    @@ -202,7 +202,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:31
  • 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
  • +
  • Defined in src/pools/abstract-pool.ts:151
  • +
  • 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
  • +
  • Defined in src/pools/thread/fixed.ts:80
  • +
  • Defined in src/pools/abstract-pool.ts:255
  • +
  • Defined in src/pools/abstract-pool.ts:293
  • +
  • Defined in src/pools/abstract-pool.ts:337
  • +
  • Defined in src/pools/thread/fixed.ts:73
  • +
  • Defined in src/pools/abstract-pool.ts:221
  • +
  • Defined in src/pools/thread/fixed.ts:49
  • +
  • Defined in src/pools/abstract-pool.ts:205
  • +
  • Defined in src/pools/abstract-pool.ts:194
  • +
  • Defined in src/pools/abstract-pool.ts:166
  • +
  • Defined in src/pools/abstract-pool.ts:156
  • +
  • Defined in src/pools/abstract-pool.ts:161
  • +
  • Defined in src/pools/abstract-pool.ts:186
  • +
  • Defined in src/pools/thread/fixed.ts:44
  • +
  • Defined in src/pools/thread/fixed.ts:65
  • +
  • Defined in src/pools/abstract-pool.ts:280
  • +
  • Defined in src/pools/thread/fixed.ts:57
  • +
  • Defined in src/pools/abstract-pool.ts:171
  • +
  • Defined in src/pools/abstract-pool.ts:240
  • +
  • Defined in src/pools/abstract-pool.ts:363
  • +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/events.d.ts:327
  • Methods

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

    Returns PoolEmitter

    +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/events.d.ts:354
  • +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/events.d.ts:610
  • +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/events.d.ts:669
  • +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/events.d.ts:526
  • +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/events.d.ts:616
  • +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/events.d.ts:539
  • +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/events.d.ts:499
  • +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/events.d.ts:385
  • +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/events.d.ts:414
  • +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/events.d.ts:634
  • +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/events.d.ts:650
  • +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/events.d.ts:569
  • +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/events.d.ts:510
  • +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/events.d.ts:494
  • +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/events.d.ts:520
  • +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/events.d.ts:299
  • +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/events.d.ts:271
  • +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/events.d.ts:254
  • @@ -699,7 +699,7 @@ special handling:

    Returns Promise<any[]>

  • +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/events.d.ts:195
  • +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/events.d.ts:317
  • +
  • Defined in src/worker/abstract-worker.ts:31
  • mainWorker: undefined | null | MessagePort
    @@ -144,7 +144,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:53
  • opts: WorkerOptions
    @@ -152,7 +152,7 @@ but the minimum number of workers will be guaranteed.

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

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

    Returns number

    +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:315
  • +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:288
  • +
  • Defined in src/worker/abstract-worker.ts:147
  • +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:311
  • +
  • Defined in src/worker/abstract-worker.ts:130
  • +
  • Defined in src/worker/abstract-worker.ts:162
  • +
  • Defined in src/worker/abstract-worker.ts:84
  • +
  • Defined in src/worker/abstract-worker.ts:172
  • +
  • Defined in src/worker/abstract-worker.ts:196
  • +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:303
  • +
  • Defined in src/worker/thread-worker.ts:36
  • +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:320
  • +
  • Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:273
  • +
  • Defined in src/pools/cluster/fixed.ts:18
  • errorHandler?: ErrorHandler<Worker>
    @@ -70,7 +70,7 @@
    +
  • Defined in src/pools/pool.ts:26
  • exitHandler?: ExitHandler<Worker>
    @@ -78,7 +78,7 @@
    +
  • Defined in src/pools/pool.ts:34
  • messageHandler?: MessageHandler<Worker>
    @@ -86,7 +86,7 @@
    +
  • Defined in src/pools/pool.ts:22
  • onlineHandler?: OnlineHandler<Worker>
    @@ -94,7 +94,7 @@
    +
  • Defined in src/pools/pool.ts:30
  • settings?: ClusterSettings
    @@ -103,7 +103,7 @@

    See

    https://nodejs.org/api/cluster.html#cluster_cluster_settings

    +
  • Defined in src/pools/cluster/fixed.ts:24
  • workerChoiceStrategy?: "ROUND_ROBIN" | "LESS_RECENTLY_USED" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
    @@ -111,7 +111,7 @@
    +
  • Defined in src/pools/pool.ts:38
  • +
  • Defined in src/pools/pool.ts:72
  • emitter?: PoolEmitter
    @@ -74,7 +74,7 @@
    +
  • Defined in src/pools/pool.ts:61
  • execute: ((data: Data) => Promise<Response>)
    @@ -98,7 +98,7 @@

    Returns Promise<Response>

    +
  • Defined in src/pools/pool.ts:68
  • 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
  • +
  • Defined in src/pools/pool.ts:38
  • +
  • Defined in src/worker/worker-options.ts:51
  • +
  • Defined in src/pools/pool-worker.ts:9
  • +
  • Defined in src/pools/pool-worker.ts:19
  • +
  • Defined in src/pools/pool-worker.ts:4
  • +
  • Defined in src/pools/pool-worker.ts:14