fix: fix dynamic pool with minimum # of workers set to zero
[poolifier.git] / src / pools / pool.ts
index 3aa9feb70b04d8ea3b321777dd053d9823d994b0..cda63d881f0bab742cf0412cfa266714fdefeb27 100644 (file)
@@ -42,6 +42,7 @@ export const PoolEvents = Object.freeze({
   ready: 'ready',
   busy: 'busy',
   full: 'full',
+  empty: 'empty',
   destroy: 'destroy',
   error: 'error',
   taskError: 'taskError',
@@ -246,9 +247,10 @@ 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.
+   * - `'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.
    * - `'busy'`: Emitted when the number of workers created in the pool has reached the maximum size expected and are executing concurrently their tasks quota.
    * - `'full'`: Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.
+   * - `'empty'`: Emitted when the pool is dynamic with a minimum number of workers set to zero and the number of workers has reached the minimum size expected.
    * - `'destroy'`: Emitted when the pool is destroyed.
    * - `'error'`: Emitted when an uncaught error occurs.
    * - `'taskError'`: Emitted when an error occurs while executing a task.