From: Jérôme Benoit <jerome.benoit@sap.com>
Date: Mon, 3 Apr 2023 21:20:17 +0000 (+0200)
Subject: docs: enhance some methods documentation
X-Git-Tag: v2.4.0-3~14
X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=7cf00f70a6dffca3af737ea9193a6c3be69ac0b7;p=poolifier.git

docs: enhance some methods 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 095a4f7b..14d9c248 100644
--- a/src/pools/abstract-pool.ts
+++ b/src/pools/abstract-pool.ts
@@ -146,7 +146,7 @@ export abstract class AbstractPool<
    * Gets the given worker key.
    *
    * @param worker - The worker.
-   * @returns The worker key.
+   * @returns The worker key if the worker is found in the pool, `-1` otherwise.
    */
   private getWorkerKey (worker: Worker): number {
     return this.workers.findIndex(workerItem => workerItem.worker === worker)