Bump expect from 29.1.0 to 29.1.2 (#572)
[poolifier.git] / CHANGELOG.md
CommitLineData
522eea03 1# Changelog
2
3All notable changes to this project will be documented in this file.
4
5The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
72ddc5cb 8## [2.2.0] - 2022-05-01
7e0d447f
JB
9
10### Breaking Changes
11
12- Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version.
13
f30df385 14## [2.1.0] - 2021-29-08
35cf1c03
JB
15
16### Added
17
18- Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
e088a00c
JB
19
20### Breaking Changes
21
22- `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
23- `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
24- `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
c365b2d3 25- `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
e088a00c 26
d7a0c5c5 27## [2.0.2] - 2021-12-05
14916bf9
JB
28
29### Bug fixes
30
31- Fix `busy` event emission on fixed pool type
32
59af1281 33## [2.0.1] - 2021-16-03
7f685093
JB
34
35### Bug fixes
36
37- Check if pool options are properly set.
38- `busy` event is emitted on all pool types.
39
3695a6b0 40## [2.0.0] - 2021-01-03
fa0f5b28 41
f3f833ab 42### Bug fixes
d63d3be3 43
ddbeaffd 44- Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
d63d3be3 45
fa0f5b28
S
46### Breaking Changes
47
7f685093 48- `FullPool` event is now renamed to `busy`.
1927ee67 49- `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
1a81f8af 50 _Find more details on our JSDoc._
ddbeaffd 51
1927ee67
APA
52- `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
53
ddbeaffd 54- We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
fa0f5b28 55
ec2ccfc8
JB
56### Pool options types declaration merge
57
58`FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
59
fa0f5b28
S
60#### New `export` strategy
61
62```js
63// Before
777b7824 64const DynamicThreadPool = require('poolifier/lib/dynamic')
fa0f5b28 65// After
777b7824 66const { DynamicThreadPool } = require('poolifier/lib/dynamic')
fa0f5b28
S
67```
68
69But you should always prefer just using
70
71```js
777b7824 72const { DynamicThreadPool } = require('poolifier')
fa0f5b28
S
73```
74
d3c8a1a8
S
75#### New type definitions for input data and response
76
ec2ccfc8 77For cluster worker and worker-thread pools, you can now only send and receive serializable data.
d3c8a1a8
S
78_This is not a limitation by poolifier but NodeJS._
79
3a4b605f 80#### Public property replacements
5c5a1fb7 81
3a4b605f 82`numWorkers` property is now `numberOfWorkers`
5c5a1fb7 83
280c2a77 84#### Internal (protected) properties and methods renaming
fa0f5b28 85
280c2a77
S
86These properties are not intended for end users
87
88- `id` => `nextMessageId`
89
90These methods are not intended for end users
fa0f5b28
S
91
92- `_chooseWorker` => `chooseWorker`
280c2a77 93- `_newWorker` => `createWorker`
fa0f5b28
S
94- `_execute` => `internalExecute`
95- `_chooseWorker` => `chooseWorker`
96- `_checkAlive` => `checkAlive`
97- `_run` => `run`
98- `_runAsync` => `runAsync`
99
0312f71a
APA
100## [1.1.0] - 2020-21-05
101
102### Added
103
104- ThreadWorker support async functions as option
cf9aa6c3 105- Various external library patches
0312f71a 106
522eea03 107## [1.0.0] - 2020-24-01
108
109### Added
110
111- FixedThreadPool implementation
112- DynamicThreadPool implementation
0312f71a 113- WorkerThread implementation to improve developer experience