From: Jérôme Benoit <jerome.benoit@sap.com>
Date: Sat, 15 Oct 2022 05:35:08 +0000 (+0200)
Subject: Silence typedoc warnings
X-Git-Tag: v2.3.2~5
X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;ds=sidebyside;h=ee6c0f814af70d315f8485f0189407b92d31294d;p=poolifier.git

Silence typedoc warnings

Signed-off-by: Jérôme Benoit <jerome.benoit@sap.com>
---

diff --git a/src/pools/cluster/dynamic.ts b/src/pools/cluster/dynamic.ts
index ebff6bfe..f18f375c 100644
--- a/src/pools/cluster/dynamic.ts
+++ b/src/pools/cluster/dynamic.ts
@@ -23,7 +23,7 @@ export class DynamicClusterPool<
    * @param min Minimum number of workers which are always active.
    * @param max Maximum number of workers that can be created by this pool.
    * @param filePath Path to an implementation of a `ClusterWorker` file, which can be relative or absolute.
-   * @param [opts={}] Options for this dynamic cluster pool.
+   * @param opts Options for this dynamic cluster pool.
    */
   public constructor (
     min: number,
diff --git a/src/pools/cluster/fixed.ts b/src/pools/cluster/fixed.ts
index 09c5e369..7ad425a3 100644
--- a/src/pools/cluster/fixed.ts
+++ b/src/pools/cluster/fixed.ts
@@ -39,7 +39,7 @@ export class FixedClusterPool<
    *
    * @param numberOfWorkers Number of workers for this pool.
    * @param filePath Path to an implementation of a `ClusterWorker` file, which can be relative or absolute.
-   * @param [opts={}] Options for this fixed cluster pool.
+   * @param opts Options for this fixed cluster pool.
    */
   public constructor (
     numberOfWorkers: number,
diff --git a/src/pools/thread/dynamic.ts b/src/pools/thread/dynamic.ts
index 929287c8..7069f7f3 100644
--- a/src/pools/thread/dynamic.ts
+++ b/src/pools/thread/dynamic.ts
@@ -24,7 +24,7 @@ export class DynamicThreadPool<
    * @param min Minimum number of threads which are always active.
    * @param max Maximum number of threads that can be created by this pool.
    * @param filePath Path to an implementation of a `ThreadWorker` file, which can be relative or absolute.
-   * @param [opts={}] Options for this dynamic thread pool.
+   * @param opts Options for this dynamic thread pool.
    */
   public constructor (
     min: number,
diff --git a/src/pools/thread/fixed.ts b/src/pools/thread/fixed.ts
index 3212678f..5b06ca49 100644
--- a/src/pools/thread/fixed.ts
+++ b/src/pools/thread/fixed.ts
@@ -30,7 +30,7 @@ export class FixedThreadPool<
    *
    * @param numberOfThreads Number of threads for this pool.
    * @param filePath Path to an implementation of a `ThreadWorker` file, which can be relative or absolute.
-   * @param [opts={}] Options for this fixed thread pool.
+   * @param opts Options for this fixed thread pool.
    */
   public constructor (
     numberOfThreads: number,