Commit | Line | Data |
---|---|---|
522eea03 | 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 | ||
fa0f5b28 S |
8 | ## [2.0.0] - not released yet |
9 | ||
f3f833ab | 10 | ### Bug fixes |
d63d3be3 | 11 | |
ddbeaffd | 12 | - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70). |
d63d3be3 | 13 | |
fa0f5b28 S |
14 | ### Breaking Changes |
15 | ||
1927ee67 | 16 | - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`. |
1a81f8af | 17 | _Find more details on our JSDoc._ |
ddbeaffd | 18 | |
1927ee67 APA |
19 | - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed. |
20 | ||
ddbeaffd | 21 | - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes. |
fa0f5b28 | 22 | |
ec2ccfc8 JB |
23 | ### Pool options types declaration merge |
24 | ||
25 | `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`. | |
26 | ||
fa0f5b28 S |
27 | #### New `export` strategy |
28 | ||
29 | ```js | |
30 | // Before | |
777b7824 | 31 | const DynamicThreadPool = require('poolifier/lib/dynamic') |
fa0f5b28 | 32 | // After |
777b7824 | 33 | const { DynamicThreadPool } = require('poolifier/lib/dynamic') |
fa0f5b28 S |
34 | ``` |
35 | ||
36 | But you should always prefer just using | |
37 | ||
38 | ```js | |
777b7824 | 39 | const { DynamicThreadPool } = require('poolifier') |
fa0f5b28 S |
40 | ``` |
41 | ||
d3c8a1a8 S |
42 | #### New type definitions for input data and response |
43 | ||
ec2ccfc8 | 44 | For cluster worker and worker-thread pools, you can now only send and receive serializable data. |
d3c8a1a8 S |
45 | _This is not a limitation by poolifier but NodeJS._ |
46 | ||
3a4b605f | 47 | #### Public property replacements |
5c5a1fb7 | 48 | |
3a4b605f S |
49 | `numWorkers` property is now `numberOfWorkers` |
50 | `nextWorker` property is now `nextWorkerIndex` | |
5c5a1fb7 | 51 | |
280c2a77 | 52 | #### Internal (protected) properties and methods renaming |
fa0f5b28 | 53 | |
280c2a77 S |
54 | These properties are not intended for end users |
55 | ||
56 | - `id` => `nextMessageId` | |
57 | ||
58 | These methods are not intended for end users | |
fa0f5b28 S |
59 | |
60 | - `_chooseWorker` => `chooseWorker` | |
280c2a77 | 61 | - `_newWorker` => `createWorker` |
fa0f5b28 S |
62 | - `_execute` => `internalExecute` |
63 | - `_chooseWorker` => `chooseWorker` | |
64 | - `_checkAlive` => `checkAlive` | |
65 | - `_run` => `run` | |
66 | - `_runAsync` => `runAsync` | |
67 | ||
0312f71a APA |
68 | ## [1.1.0] - 2020-21-05 |
69 | ||
70 | ### Added | |
71 | ||
72 | - ThreadWorker support async functions as option | |
cf9aa6c3 | 73 | - Various external library patches |
0312f71a | 74 | |
522eea03 | 75 | ## [1.0.0] - 2020-24-01 |
76 | ||
77 | ### Added | |
78 | ||
79 | - FixedThreadPool implementation | |
80 | - DynamicThreadPool implementation | |
0312f71a | 81 | - WorkerThread implementation to improve developer experience |