From: Jérôme Benoit Date: Sat, 20 Feb 2021 16:08:48 +0000 (+0100) Subject: Document the breaking change merge of pool options types declaration (#205) X-Git-Tag: v2.0.0-beta.7~9 X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=ec2ccfc827cf319fa709ca640ed9ebbb8ed84777;p=poolifier.git Document the breaking change merge of pool options types declaration (#205) Co-authored-by: Shinigami Co-authored-by: Alessandro Pio Ardizio --- diff --git a/CHANGELOG.md b/CHANGELOG.md index a65e1c3f..03763a6e 100644 --- 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`. + #### 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 95b3f0c1..ed9df457 100644 --- 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