docs: enhance error message

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

diff --git a/src/pools/abstract-pool.ts b/src/pools/abstract-pool.ts
index 1fd9a1737f10991489af3b006829dcaf3e7bd580..99f65a24a0ee85f606ab7937653cf0b641472bc8 100644 (file)
--- a/src/pools/abstract-pool.ts
+++ b/src/pools/abstract-pool.ts
@@ -142,7 +142,7 @@ export abstract class AbstractPool<
     if (this.opts.enableTasksQueue) {
       if ((opts.tasksQueueOptions?.concurrency as number) <= 0) {
         throw new Error(
-          `Invalid tasks queue concurrency '${
+          `Invalid worker tasks concurrency '${
             (opts.tasksQueueOptions as TasksQueueOptions).concurrency as number
           }'`
         )

diff --git a/src/pools/pool-internal.ts b/src/pools/pool-internal.ts
index 8912dd2c18f8a99a6791b006f672442e5be5ecdf..b245e360df704ee1e7fde5ce4e114da060cc70fd 100644 (file)
--- a/src/pools/pool-internal.ts
+++ b/src/pools/pool-internal.ts
@@ -7,7 +7,13 @@ import type { IWorker, WorkerNode } from './worker'
  * @enum
  */
 export enum PoolType {
+  /**
+   * Fixed pool type.
+   */
   FIXED = 'fixed',
+  /**
+   * Dynamic pool type.
+   */
   DYNAMIC = 'dynamic'
 }
 

diff --git a/src/pools/selection-strategies/selection-strategies-types.ts b/src/pools/selection-strategies/selection-strategies-types.ts
index 23dc5e8c9a4e744ed605beeaaca1b38b4e2d944d..7fbe40f28fa3b5d9cc1b8e976a3f46ec45ed9974 100644 (file)
--- a/src/pools/selection-strategies/selection-strategies-types.ts
+++ b/src/pools/selection-strategies/selection-strategies-types.ts
@@ -43,8 +43,17 @@ export interface WorkerChoiceStrategyOptions {
  * Pool worker tasks usage statistics requirements.
  */
 export interface RequiredStatistics {
+  /**
+   * Require tasks run time.
+   */
   runTime: boolean
+  /**
+   * Require tasks average run time.
+   */
   avgRunTime: boolean
+  /**
+   * Require tasks median run time.
+   */
   medRunTime: boolean
 }