docs: improve code documentation

[poolifier.git] / src / pools / pool.ts

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>
   /**