From: Jérôme Benoit <jerome.benoit@sap.com>
Date: Wed, 12 Apr 2023 09:17:09 +0000 (+0200)
Subject: docs: enhance documentation
X-Git-Tag: v2.4.8~6
X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=71ebe93bc57165070056097e96efc45b15a580e6;p=poolifier.git

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 9f7813e7..3be40e6d 100644
--- 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 6b957c37..5c90ff77 100644
--- 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 7fbe40f2..065b310f 100644
--- 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 3a454f3e..e48ded53 100644
--- 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,