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 907bfcb5982f8e1916877e516c3e791eddcc5be0..4115ab5b9a5c7d5d99e1b869ff5340fab42d9c5b 100644 (file)
--- 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 f9a504351a4bbbe9d33bddc145c457a7ce27ef78..fa0d0f641a4b8618efa7346a3ba4029a93bc533b 100644 (file)
--- 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 82aed5526c976a1d05691dd04d922d4f33bcd5ee..8d62712b5d598ada970ae337ddee7eb2406f9193 100644 (file)
--- 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
   /**