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