docs: refine pool ready event emission condition
authorJérôme Benoit <jerome.benoit@piment-noir.org>
Wed, 28 Aug 2024 14:25:41 +0000 (16:25 +0200)
committerJérôme Benoit <jerome.benoit@piment-noir.org>
Wed, 28 Aug 2024 14:25:41 +0000 (16:25 +0200)
Signed-off-by: Jérôme Benoit <jerome.benoit@piment-noir.org>
src/pools/pool.ts

index bb772dc8eb9fa7479c1cab73ae25786066f08d61..dac342ec8cbe3fa9feb77bc681b7a59794c30c54 100644 (file)
@@ -285,7 +285,7 @@ export interface IPool<
    *
    * Events that can currently be listened to:
    *
-   * - `'ready'`: Emitted when the number of workers created in the pool has reached the minimum size expected and are ready. If the pool is dynamic with a minimum number of workers is set to zero, this event is emitted when at least one dynamic worker is ready.
+   * - `'ready'`: Emitted when the number of workers created in the pool has reached the minimum size expected and are ready. If the pool is dynamic with a minimum number of workers set to zero, this event is emitted when the pool is started.
    * - `'busy'`: Emitted when the number of workers created in the pool has reached the maximum size expected and are executing concurrently their tasks quota.
    * - `'busyEnd'`: Emitted when the number of workers created in the pool has reached the maximum size expected and are no longer executing concurrently their tasks quota.
    * - `'full'`: Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.