docs: enhance some methods documentation
authorJérôme Benoit <jerome.benoit@sap.com>
Mon, 3 Apr 2023 21:20:17 +0000 (23:20 +0200)
committerJérôme Benoit <jerome.benoit@sap.com>
Mon, 3 Apr 2023 21:20:17 +0000 (23:20 +0200)
Signed-off-by: Jérôme Benoit <jerome.benoit@sap.com>
src/pools/abstract-pool.ts

index 095a4f7b99840ff1c0ff9074d6cd66dca2efa1d0..14d9c24870b0c05083c13936a0997b93e9e5619e 100644 (file)
@@ -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)