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.1.0] - 2021-dd-mm
12 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
13 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
14 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
15 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
17 ## [2.0.2] - 2021-12-05
21 - Fix `busy` event emission on fixed pool type
23 ## [2.0.1] - 2021-16-03
27 - Check if pool options are properly set.
28 - `busy` event is emitted on all pool types.
30 ## [2.0.0] - 2021-01-03
34 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
38 - `FullPool` event is now renamed to `busy`.
39 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
40 _Find more details on our JSDoc._
42 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
44 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
46 ### Pool options types declaration merge
48 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
50 #### New `export` strategy
54 const DynamicThreadPool = require('poolifier/lib/dynamic')
56 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
59 But you should always prefer just using
62 const { DynamicThreadPool } = require('poolifier')
65 #### New type definitions for input data and response
67 For cluster worker and worker-thread pools, you can now only send and receive serializable data.
68 _This is not a limitation by poolifier but NodeJS._
70 #### Public property replacements
72 `numWorkers` property is now `numberOfWorkers`
74 #### Internal (protected) properties and methods renaming
76 These properties are not intended for end users
78 - `id` => `nextMessageId`
80 These methods are not intended for end users
82 - `_chooseWorker` => `chooseWorker`
83 - `_newWorker` => `createWorker`
84 - `_execute` => `internalExecute`
85 - `_chooseWorker` => `chooseWorker`
86 - `_checkAlive` => `checkAlive`
88 - `_runAsync` => `runAsync`
90 ## [1.1.0] - 2020-21-05
94 - ThreadWorker support async functions as option
95 - Various external library patches
97 ## [1.0.0] - 2020-24-01
101 - FixedThreadPool implementation
102 - DynamicThreadPool implementation
103 - WorkerThread implementation to improve developer experience