docs: improve 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 7c6f6769212c45513453af5d3b373f2b752f4c62..87f4a8fa03f781aab2a17926fd98ab088387bf1b 100644 (file)
--- a/src/pools/pool.ts
+++ b/src/pools/pool.ts
@@ -72,9 +72,13 @@ export interface PoolInfo {
   worker: WorkerType
   minSize: number
   maxSize: number
+  /** Pool utilization ratio. */
   utilization: number
+  /** Pool total worker nodes */
   workerNodes: number
+  /** Pool idle worker nodes */
   idleWorkerNodes: number
+  /** Pool busy worker nodes */
   busyWorkerNodes: number
   executedTasks: number
   executingTasks: number
@@ -189,7 +193,7 @@ export interface IPool<
    */
   execute: (data?: Data, name?: string) => Promise<Response>
   /**
-   * Terminate every current worker in this pool.
+   * Terminates every current worker in this pool.
    */
   destroy: () => Promise<void>
   /**

diff --git a/src/pools/selection-strategies/selection-strategies-types.ts b/src/pools/selection-strategies/selection-strategies-types.ts
index ac2ee6c3ca6b97f96c0e16a8ccf04e9557246090..dc1748140a8a3db121b4f904ccafda718a14411e 100644 (file)
--- a/src/pools/selection-strategies/selection-strategies-types.ts
+++ b/src/pools/selection-strategies/selection-strategies-types.ts
@@ -107,15 +107,15 @@ export interface WorkerChoiceStrategyOptions {
  */
 export interface MeasurementStatisticsRequirements {
   /**
-   * Require measurement aggregate.
+   * Requires measurement aggregate.
    */
   aggregate: boolean
   /**
-   * Require measurement average.
+   * Requires measurement average.
    */
   average: boolean
   /**
-   * Require measurement median.
+   * Requires measurement median.
    */
   median: boolean
 }

diff --git a/src/pools/worker.ts b/src/pools/worker.ts
index 86f5121dd1d73239c925c51319b6ff8bdc9b2a03..dc283e0eaf9298a683dcfffba8dbaabf4afb6cc2 100644 (file)
--- a/src/pools/worker.ts
+++ b/src/pools/worker.ts
@@ -147,7 +147,7 @@ export interface WorkerUsage {
  */
 export interface IWorker {
   /**
-   * Register an event listener.
+   * Registers an event listener.
    *
    * @param event - The event.
    * @param handler - The event handler.
@@ -157,7 +157,7 @@ export interface IWorker {
   ((event: 'online', handler: OnlineHandler<this>) => void) &
   ((event: 'exit', handler: ExitHandler<this>) => void)
   /**
-   * Register a listener to the exit event that will only be performed once.
+   * Registers a listener to the exit event that will only be performed once.
    *
    * @param event - `'exit'`.
    * @param handler - The exit handler.

diff --git a/src/queue.ts b/src/queue.ts
index e7c9dd11fc0332ccbba845e9bd663d4bc682c523..ead4b6375388398483eda10abaaae50e2c779928 100644 (file)
--- a/src/queue.ts
+++ b/src/queue.ts
@@ -51,7 +51,7 @@ export class Queue<T> {
   }
 
   /**
-   * Peek at the first item.
+   * Peeks at the first item.
    *
    * @returns The first item or `undefined` if the queue is empty.
    */
@@ -63,7 +63,7 @@ export class Queue<T> {
   }
 
   /**
-   * Clear the queue.
+   * Clears the queue.
    */
   public clear (): void {
     this.items = []

diff --git a/src/utils.ts b/src/utils.ts
index 6d11f88cf6d964bfc9f36fe79b5c3eda3810d35b..7ac4ab25db67446a49b2fc42a0f219c043d4af6f 100644 (file)
--- a/src/utils.ts
+++ b/src/utils.ts
@@ -73,6 +73,7 @@ export const median = (dataSet: number[]): number => {
 
 /**
  * Rounds the given number to the given scale.
+ * The rounding is done using the "round half away from zero" method.
  *
  * @param num - The number to round.
  * @param scale - The scale to round to.