From: Jérôme Benoit <jerome.benoit@sap.com>
Date: Sat, 15 Apr 2023 12:46:13 +0000 (+0200)
Subject: docs: refine code documentation
X-Git-Tag: v2.4.9~7
X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=d29bce7c35c0be75535b4d1eb0f22ef38b3f8204;p=poolifier.git

docs: refine code documentation

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

diff --git a/src/pools/pool.ts b/src/pools/pool.ts
index 907bfcb5..4115ab5b 100644
--- a/src/pools/pool.ts
+++ b/src/pools/pool.ts
@@ -83,6 +83,8 @@ export interface PoolOptions<Worker extends IWorker> {
   exitHandler?: ExitHandler<Worker>
   /**
    * The worker choice strategy to use in this pool.
+   *
+   * @defaultValue 'ROUND_ROBIN'
    */
   workerChoiceStrategy?: WorkerChoiceStrategy
   /**
diff --git a/src/pools/selection-strategies/selection-strategies-types.ts b/src/pools/selection-strategies/selection-strategies-types.ts
index f9a50435..fa0d0f64 100644
--- a/src/pools/selection-strategies/selection-strategies-types.ts
+++ b/src/pools/selection-strategies/selection-strategies-types.ts
@@ -35,6 +35,8 @@ export type WorkerChoiceStrategy = keyof typeof WorkerChoiceStrategies
 export interface WorkerChoiceStrategyOptions {
   /**
    * Use tasks median run time instead of average run time.
+   *
+   * @defaultValue false
    */
   medRunTime?: boolean
 }
diff --git a/src/pools/worker.ts b/src/pools/worker.ts
index 82aed552..8d62712b 100644
--- a/src/pools/worker.ts
+++ b/src/pools/worker.ts
@@ -37,7 +37,7 @@ export type ExitHandler<Worker extends IWorker> = (
  */
 export interface Task<Data = unknown> {
   /**
-   * Input data that will be passed to the worker.
+   * Task input data that will be passed to the worker.
    */
   readonly data?: Data
   /**