X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=README.md;h=da1690207e21ce6cea04dbe87f3768f3641132d6;hb=765457872257684691f93befb94175a2aaa83502;hp=1248db3f814f1dc273841b77d9171a7d0893940d;hpb=cb9eb0854231e0b76e30eb87653032570a989b99;p=poolifier.git diff --git a/README.md b/README.md index 1248db3f..da169020 100644 --- 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 @@ -171,7 +174,14 @@ Node versions >= 16.x are supported. `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` and `WorkerChoiceStrategies.FAIR_SHARE` strategies are targeted to heavy and long tasks Default: `WorkerChoiceStrategies.ROUND_ROBIN` +- `workerChoiceStrategyOptions` (optional) - The worker choice strategy options object to use in this pool. + Properties: + + - `medRunTime` (optional) - Use the tasks median run time instead of the tasks average run time in worker choice strategies. + Default: { medRunTime: false } + - `enableEvents` (optional) - Events emission enablement in this pool. Default: true +- `enableTasksQueue` (optional, experimental) - Tasks queue per worker enablement in this pool. Default: false ### `pool = new DynamicThreadPool/DynamicClusterPool(min, max, filePath, opts)`