docs: fix findFreeWorkerKey() return value
authorJérôme Benoit <jerome.benoit@sap.com>
Fri, 7 Apr 2023 15:08:02 +0000 (17:08 +0200)
committerJérôme Benoit <jerome.benoit@sap.com>
Fri, 7 Apr 2023 15:08:02 +0000 (17:08 +0200)
Signed-off-by: Jérôme Benoit <jerome.benoit@sap.com>
src/pools/pool-internal.ts

index ddfcc41ec40758e8520a2d708bf823aaaebeb39c..c3ec39bea578d3de3c0423f2ef789e0cd6c6f9df 100644 (file)
@@ -75,7 +75,7 @@ export interface IPoolInternal<
    *
    * If a worker is found with `0` running tasks, it is detected as free and its key is returned.
    *
-   * If no free worker is found, `false` is returned.
+   * If no free worker is found, `-1` is returned.
    *
    * @returns A worker key if there is one, `-1` otherwise.
    */