3 All notable changes to this project will be documented in this file.
5 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
8 ## [2.2.2] - 2022-09-10
12 - Fixed `README.md` file.
14 ## [2.2.1] - 2022-08-10
18 - Dynamic worker choice strategy change at runtime.
20 ## [2.2.0] - 2022-05-01
24 - Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version.
26 ## [2.1.0] - 2021-29-08
30 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
34 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
35 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
36 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
37 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
39 ## [2.0.2] - 2021-12-05
43 - Fix `busy` event emission on fixed pool type
45 ## [2.0.1] - 2021-16-03
49 - Check if pool options are properly set.
50 - `busy` event is emitted on all pool types.
52 ## [2.0.0] - 2021-01-03
56 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
60 - `FullPool` event is now renamed to `busy`.
61 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
62 _Find more details on our JSDoc._
64 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
66 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
68 ### Pool options types declaration merge
70 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
72 #### New `export` strategy
76 const DynamicThreadPool = require('poolifier/lib/dynamic')
78 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
81 But you should always prefer just using
84 const { DynamicThreadPool } = require('poolifier')
87 #### New type definitions for input data and response
89 For cluster worker and worker-thread pools, you can now only send and receive serializable data.
90 _This is not a limitation by poolifier but NodeJS._
92 #### Public property replacements
94 `numWorkers` property is now `numberOfWorkers`
96 #### Internal (protected) properties and methods renaming
98 These properties are not intended for end users
100 - `id` => `nextMessageId`
102 These methods are not intended for end users
104 - `_chooseWorker` => `chooseWorker`
105 - `_newWorker` => `createWorker`
106 - `_execute` => `internalExecute`
107 - `_chooseWorker` => `chooseWorker`
108 - `_checkAlive` => `checkAlive`
110 - `_runAsync` => `runAsync`
112 ## [1.1.0] - 2020-21-05
116 - ThreadWorker support async functions as option
117 - Various external library patches
119 ## [1.0.0] - 2020-24-01
123 - FixedThreadPool implementation
124 - DynamicThreadPool implementation
125 - WorkerThread implementation to improve developer experience