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.1] - 2022-05-01
12 - Dynamic worker choice strategy change at runtime.
14 ## [2.2.0] - 2022-05-01
18 - Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version.
20 ## [2.1.0] - 2021-29-08
24 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
28 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
29 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
30 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
31 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
33 ## [2.0.2] - 2021-12-05
37 - Fix `busy` event emission on fixed pool type
39 ## [2.0.1] - 2021-16-03
43 - Check if pool options are properly set.
44 - `busy` event is emitted on all pool types.
46 ## [2.0.0] - 2021-01-03
50 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
54 - `FullPool` event is now renamed to `busy`.
55 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
56 _Find more details on our JSDoc._
58 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
60 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
62 ### Pool options types declaration merge
64 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
66 #### New `export` strategy
70 const DynamicThreadPool = require('poolifier/lib/dynamic')
72 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
75 But you should always prefer just using
78 const { DynamicThreadPool } = require('poolifier')
81 #### New type definitions for input data and response
83 For cluster worker and worker-thread pools, you can now only send and receive serializable data.
84 _This is not a limitation by poolifier but NodeJS._
86 #### Public property replacements
88 `numWorkers` property is now `numberOfWorkers`
90 #### Internal (protected) properties and methods renaming
92 These properties are not intended for end users
94 - `id` => `nextMessageId`
96 These methods are not intended for end users
98 - `_chooseWorker` => `chooseWorker`
99 - `_newWorker` => `createWorker`
100 - `_execute` => `internalExecute`
101 - `_chooseWorker` => `chooseWorker`
102 - `_checkAlive` => `checkAlive`
104 - `_runAsync` => `runAsync`
106 ## [1.1.0] - 2020-21-05
110 - ThreadWorker support async functions as option
111 - Various external library patches
113 ## [1.0.0] - 2020-24-01
117 - FixedThreadPool implementation
118 - DynamicThreadPool implementation
119 - WorkerThread implementation to improve developer experience