From: Jérôme Benoit <jerome.benoit@sap.com>
Date: Tue, 11 Apr 2023 22:50:09 +0000 (+0200)
Subject: docs: align type definitions
X-Git-Tag: v2.4.8~8
X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=d480d708d7b0bf5dc1086b0469ad82ee413223f1;p=poolifier.git

docs: align type definitions

Signed-off-by: Jérôme Benoit <jerome.benoit@sap.com>
---

diff --git a/src/pools/pool.ts b/src/pools/pool.ts
index 4395712f..6b957c37 100644
--- a/src/pools/pool.ts
+++ b/src/pools/pool.ts
@@ -61,7 +61,7 @@ export interface TasksQueueOptions {
 /**
  * Options for a poolifier pool.
  *
- * @typeParam Worker - The worker type.
+ * @typeParam Worker - Type of worker.
  */
 export interface PoolOptions<Worker extends IWorker> {
   /**
diff --git a/src/worker/worker-options.ts b/src/worker/worker-options.ts
index 4e5a3d07..30da0a64 100644
--- a/src/worker/worker-options.ts
+++ b/src/worker/worker-options.ts
@@ -20,7 +20,7 @@ export type KillBehavior = keyof typeof KillBehaviors
 /**
  * Detects whether the given value is a kill behavior or not.
  *
- * @typeParam KB - Which specific KillBehavior to test against.
+ * @typeParam KB - Which specific KillBehavior type to test against.
  * @param killBehavior - Which kind of kill behavior to detect.
  * @param value - Any value.
  * @returns `true` if `value` was strictly equals to `killBehavior`, otherwise `false`.