refactor: add PoolEvents/PoolEvent types

[poolifier.git] / README.md

diff --git a/README.md b/README.md
index b86b69eb778f6e3d606701a47e3e55b96881c6cc..49f24ef5e11c6e201568c99f7386716a2933b053 100644 (file)
--- a/README.md
+++ b/README.md
@@ -113,19 +113,22 @@ Instantiate your pool based on your needed :
 
 ```js
 'use strict'
-const { FixedThreadPool, DynamicThreadPool } = require('poolifier')
+const { DynamicThreadPool, FixedThreadPool, PoolEvents } = require('poolifier')
 
 // a fixed worker-threads pool
 const pool = new FixedThreadPool(15,
   './yourWorker.js',
   { errorHandler: (e) => console.error(e), onlineHandler: () => console.log('worker is online') })
 
+pool.emitter.on(PoolEvents.busy, () => console.log('Pool is busy'))
+
 // or a dynamic worker-threads pool
 const pool = new DynamicThreadPool(10, 100,
   './yourWorker.js',
   { errorHandler: (e) => console.error(e), onlineHandler: () => console.log('worker is online') })
 
-pool.emitter.on('busy', () => console.log('Pool is busy'))
+pool.emitter.on(PoolEvents.full, () => console.log('Pool is full'))
+pool.emitter.on(PoolEvents.busy, () => console.log('Pool is busy'))
 
 // the execute method signature is the same for both implementations,
 // so you can easy switch from one to another
@@ -165,7 +168,7 @@ Node versions >= 16.x are supported.
   - `WorkerChoiceStrategies.ROUND_ROBIN`: Submit tasks to worker in a round robbin fashion
   - `WorkerChoiceStrategies.LESS_USED`: Submit tasks to the less used worker
   - `WorkerChoiceStrategies.LESS_BUSY`: Submit tasks to the less busy worker
-  - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` Submit tasks to worker using a weighted round robin scheduling algorithm based on tasks execution time
+  - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN`: Submit tasks to worker using a weighted round robin scheduling algorithm based on tasks execution time
   - `WorkerChoiceStrategies.FAIR_SHARE`: Submit tasks to worker using a fair share tasks scheduling algorithm based on tasks execution time
 
   `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` and `WorkerChoiceStrategies.FAIR_SHARE` strategies are targeted to heavy and long tasks