Document the breaking change merge of pool options types declaration (#205)

Co-authored-by: Shinigami <chrissi92@hotmail.de>
Co-authored-by: Alessandro Pio Ardizio <alessandroardizio94@gmail.com>

diff --git a/CHANGELOG.md b/CHANGELOG.md
index a65e1c3fe5c662415c8af7efa46698675871e676..03763a6e6f1def336fb026eaeb8065bf051d9763 100644 (file)
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -18,6 +18,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - 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
@@ -35,7 +39,7 @@ 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.  
+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

diff --git a/README.md b/README.md
index 95b3f0c1e4f64735369fa8e4aede0c99ddfe45c5..ed9df457b3f6227465ece3458a7e5342a0d2adf8 100644 (file)
--- a/README.md
+++ b/README.md
@@ -137,7 +137,7 @@ You can do the same with the classes ClusterWorker, FixedClusterPool and Dynamic
 **See examples folder for more details (in particular if you want to use a pool for [multiple functions](./examples/multiFunctionExample.js)).**  
 **Now TypeScript is also supported, find how to use it into the example folder**.
 
-Remember that workers can only send and receive serializable (JSON) data.
+Remember that workers can only send and receive serializable data.
 
 ## Node versions