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