README.md: Small refinements

[poolifier.git] / CHANGELOG.md

diff --git a/CHANGELOG.md b/CHANGELOG.md
index cf61e7816c3cb4fb5ae3efd4904e5f1b3fe6da1a..a65e1c3fe5c662415c8af7efa46698675871e676 100644 (file)
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -5,6 +5,60 @@ 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
+
+### 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
+
+- `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.
+
+#### New `export` strategy
+
+```js
+// Before
+const DynamicThreadPool = require('poolifier/lib/dynamic')
+// After
+const { DynamicThreadPool } = require('poolifier/lib/dynamic')
+```
+
+But you should always prefer just using
+
+```js
+const { DynamicThreadPool } = require('poolifier')
+```
+
+#### New type definitions for input data and response
+
+For cluster worker and worker-thread pools, you can now only send and receive serializable `JSON` 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`
+
+These methods are not intended for end users
+
+- `_chooseWorker` => `chooseWorker`
+- `_newWorker` => `createWorker`
+- `_execute` => `internalExecute`
+- `_chooseWorker` => `chooseWorker`
+- `_checkAlive` => `checkAlive`
+- `_run` => `run`
+- `_runAsync` => `runAsync`
+
 ## [1.1.0] - 2020-21-05
 
 ### Added