docs: enhance documentation

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 9f7813e74cd7bd2579081ef9fd83facef0c59fdf..3be40e6d9cc8dd2634ab02569abd6261dca6f326 100644 (file)
--- a/src/pools/abstract-pool.ts
+++ b/src/pools/abstract-pool.ts
@@ -506,6 +506,7 @@ export abstract class AbstractPool<
    * Gets the given worker its tasks usage in the pool.
    *
    * @param worker - The worker.
+   * @throws {@link Error} if the worker is not found in the pool worker nodes.
    * @returns The worker tasks usage.
    */
   private getWorkerTasksUsage (worker: Worker): TasksUsage | undefined {

diff --git a/src/pools/pool.ts b/src/pools/pool.ts
index 6b957c372cfd2346b4d56bbbae46ce2015ea155f..5c90ff77c8b3e62ea444bbb998f03ec53937dc1f 100644 (file)
--- a/src/pools/pool.ts
+++ b/src/pools/pool.ts
@@ -16,6 +16,7 @@ import type {
  * Pool types.
  *
  * @enum
+ * @internal
  */
 export enum PoolType {
   /**

diff --git a/src/pools/selection-strategies/selection-strategies-types.ts b/src/pools/selection-strategies/selection-strategies-types.ts
index 7fbe40f28fa3b5d9cc1b8e976a3f46ec45ed9974..065b310fa5e8a3454f84d5b0edd6324c7c2d0520 100644 (file)
--- a/src/pools/selection-strategies/selection-strategies-types.ts
+++ b/src/pools/selection-strategies/selection-strategies-types.ts
@@ -41,6 +41,8 @@ export interface WorkerChoiceStrategyOptions {
 
 /**
  * Pool worker tasks usage statistics requirements.
+ *
+ * @internal
  */
 export interface RequiredStatistics {
   /**

diff --git a/src/utility-types.ts b/src/utility-types.ts
index 3a454f3e6b8d0e1ee1c3a64897206f04c35c3ef8..e48ded5373695b4f778d43da19f00c2cf5b0ee3f 100644 (file)
--- a/src/utility-types.ts
+++ b/src/utility-types.ts
@@ -13,6 +13,7 @@ export type Draft<T> = { -readonly [P in keyof T]?: T[P] }
  *
  * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
  * @typeParam MainWorker - Type of main worker.
+ * @internal
  */
 export interface MessageValue<
   Data = unknown,