Implement PR reviews
[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
fa0f5b28
S
8## [2.0.0] - not released yet
9
f3f833ab 10### Bug fixes
d63d3be3 11
12- Now a thread/process is not delete when the task submitted take more time than maxInactiveTime configured (issue #70)
13
fa0f5b28
S
14### Breaking Changes
15
16We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
17
18#### New `export` strategy
19
20```js
21// Before
777b7824 22const DynamicThreadPool = require('poolifier/lib/dynamic')
fa0f5b28 23// After
777b7824 24const { DynamicThreadPool } = require('poolifier/lib/dynamic')
fa0f5b28
S
25```
26
27But you should always prefer just using
28
29```js
777b7824 30const { DynamicThreadPool } = require('poolifier')
fa0f5b28
S
31```
32
d3c8a1a8
S
33#### New type definitions for input data and response
34
35For cluster and thread pools, you can now only send and receive serializable `JSON` data.
36_This is not a limitation by poolifier but NodeJS._
37
5c5a1fb7
S
38#### Public properties renaming
39
40- Thread Pool's `numWorkers` is now `numberOfWorkers`
280c2a77 41- Thread Pool's `nextWorker` is now `nextWorkerIndex`
5c5a1fb7 42
280c2a77 43#### Internal (protected) properties and methods renaming
fa0f5b28 44
280c2a77
S
45These properties are not intended for end users
46
47- `id` => `nextMessageId`
48
49These methods are not intended for end users
fa0f5b28
S
50
51- `_chooseWorker` => `chooseWorker`
280c2a77 52- `_newWorker` => `createWorker`
fa0f5b28
S
53- `_execute` => `internalExecute`
54- `_chooseWorker` => `chooseWorker`
55- `_checkAlive` => `checkAlive`
56- `_run` => `run`
57- `_runAsync` => `runAsync`
58
0312f71a
APA
59## [1.1.0] - 2020-21-05
60
61### Added
62
63- ThreadWorker support async functions as option
cf9aa6c3 64- Various external library patches
0312f71a 65
522eea03 66## [1.0.0] - 2020-24-01
67
68### Added
69
70- FixedThreadPool implementation
71- DynamicThreadPool implementation
0312f71a 72- WorkerThread implementation to improve developer experience