Bump to beta 7 version

[poolifier.git] / CHANGELOG.md

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 8479f0429b42ef98a0bdcfd38917728cda09f576..03763a6e6f1def336fb026eaeb8065bf051d9763 100644 (file)
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -7,31 +7,56 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [2.0.0] - not released yet
 
+### Bug fixes
+
+- Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
+
 ### Breaking Changes
 
-We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
+- `maxInactiveTime` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
+  _Find more details on our JSDoc._
+
+- 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
 // Before
-const DynamicThreadPool = require("poolifier/lib/dynamic");
+const DynamicThreadPool = require('poolifier/lib/dynamic')
 // After
-const { DynamicThreadPool } = require("poolifier/lib/dynamic");
+const { DynamicThreadPool } = require('poolifier/lib/dynamic')
 ```
 
 But you should always prefer just using
 
 ```js
-const { DynamicThreadPool } = require("poolifier");
+const { DynamicThreadPool } = require('poolifier')
 ```
 
-#### Internal (protected) methods has renamed
+#### New type definitions for input data and response
+
+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 property replacements
+
+`numWorkers` property is now `numberOfWorkers`
+`nextWorker` property is now `nextWorkerIndex`
+
+#### Internal (protected) properties and methods renaming
+
+These properties are not intended for end users
+
+- `id` => `nextMessageId`
 
-Those methods are not intended to be used from final users
+These methods are not intended for end users
 
 - `_chooseWorker` => `chooseWorker`
-- `_newWorker` => `newWorker`
+- `_newWorker` => `createWorker`
 - `_execute` => `internalExecute`
 - `_chooseWorker` => `chooseWorker`
 - `_checkAlive` => `checkAlive`