build: silence linter on TS code examples

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

diff --git a/src/pools/pool.ts b/src/pools/pool.ts
index 881ea62a04d0ffba4fe6d30de4bd30827c1719dd..45915e5581085b6cced9f5d51635205ee9da4556 100644 (file)
--- a/src/pools/pool.ts
+++ b/src/pools/pool.ts
@@ -64,18 +64,18 @@ export interface PoolInfo {
   readonly strategy: WorkerChoiceStrategy
   readonly minSize: number
   readonly maxSize: number
-  /** Pool utilization ratio. */
+  /** Pool utilization. */
   readonly utilization?: number
-  /** Pool total worker nodes */
+  /** Pool total worker nodes. */
   readonly workerNodes: number
-  /** Pool idle worker nodes */
+  /** Pool idle worker nodes. */
   readonly idleWorkerNodes: number
-  /** Pool busy worker nodes */
+  /** Pool busy worker nodes. */
   readonly busyWorkerNodes: number
   readonly executedTasks: number
   readonly executingTasks: number
-  readonly queuedTasks: number
-  readonly maxQueuedTasks: number
+  readonly queuedTasks?: number
+  readonly maxQueuedTasks?: number
   readonly failedTasks: number
   readonly runTime?: {
     readonly minimum: number
@@ -192,13 +192,13 @@ export interface IPool<
   /**
    * Executes the specified function in the worker constructor with the task data input parameter.
    *
-   * @param data - The task input data for the specified worker function. This can only be structured-cloneable data.
-   * @param name - The name of the worker function to execute. If not specified, the default worker function will be executed.
+   * @param data - The task input data for the specified task function. This can only be structured-cloneable data.
+   * @param name - The name of the task function to execute. If not specified, the default task function will be executed.
    * @returns Promise that will be fulfilled when the task is completed.
    */
   readonly execute: (data?: Data, name?: string) => Promise<Response>
   /**
-   * Terminates every current worker in this pool.
+   * Terminates all workers in this pool.
    */
   readonly destroy: () => Promise<void>
   /**