Apply dependencies update (#482)

[poolifier.git] / CHANGELOG.md

diff --git a/CHANGELOG.md b/CHANGELOG.md
index f70cef0a744799d8194d3f479bcf5dee97a77808..6d75ac56d075338390eb9cc0191b5b6bcfe21850 100644 (file)
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -5,7 +5,29 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [2.0.0] - not released yet
+## [2.1.0] - 2021-dd-mm
+
+### Breaking Changes
+
+- `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
+- `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
+- `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
+- `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
+
+## [2.0.2] - 2021-12-05
+
+### Bug fixes
+
+- Fix `busy` event emission on fixed pool type
+
+## [2.0.1] - 2021-16-03
+
+### Bug fixes
+
+- Check if pool options are properly set.
+- `busy` event is emitted on all pool types.
+
+## [2.0.0] - 2021-01-03
 
 ### Bug fixes
 
@@ -13,10 +35,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Breaking Changes
 
-- maxInactiveTime default behavior is now changed, if you want to keep the old behavior set killBehavior to HARD ( Find more details on our JSDoc ).
+- `FullPool` event is now renamed to `busy`.
+- `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
+  _Find more details on our JSDoc._
+
+- `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
 
 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
 
+### Pool options types declaration merge
+
+`FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
+
 #### New `export` strategy
 
 ```js
@@ -34,13 +64,12 @@ const { DynamicThreadPool } = require('poolifier')
 
 #### New type definitions for input data and response
 
-For cluster and thread pools, you can now only send and receive serializable `JSON` data.  
+For cluster worker and worker-thread pools, you can now only send and receive serializable data.  
 _This is not a limitation by poolifier but NodeJS._
 
-#### Public properties renaming
+#### Public property replacements
 
-- Thread Pool's `numWorkers` is now `numberOfWorkers`
-- Thread Pool's `nextWorker` is now `nextWorkerIndex`
+`numWorkers` property is now `numberOfWorkers`
 
 #### Internal (protected) properties and methods renaming