[poolifier.git] / CHANGELOG.md

# Changelog

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

### Breaking Changes

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 and thread pools, you can now only send and receive serializable `JSON` data.  
_This is not a limitation by poolifier but NodeJS._

#### Public properties renaming

- Thread Pool's `numWorkers` is now `numberOfWorkers`

#### Internal (protected) methods renaming

Those methods are not intended to be used from final users

- `_chooseWorker` => `chooseWorker`
- `_newWorker` => `newWorker`
- `_execute` => `internalExecute`
- `_chooseWorker` => `chooseWorker`
- `_checkAlive` => `checkAlive`
- `_run` => `run`
- `_runAsync` => `runAsync`

## [1.1.0] - 2020-21-05

### Added

- ThreadWorker support async functions as option
- Various external library patches

## [1.0.0] - 2020-24-01

### Added

- FixedThreadPool implementation
- DynamicThreadPool implementation
- WorkerThread implementation to improve developer experience
Commit	Line	Data
	1	# Changelog
	2
	3	All notable changes to this project will be documented in this file.
	4
	5	The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
	6	and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
	7
	8	## [2.0.0] - not released yet
	9
	10	### Breaking Changes
	11
	12	We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
	13
	14	#### New `export` strategy
	15
	16	```js
	17	// Before
	18	const DynamicThreadPool = require('poolifier/lib/dynamic')
	19	// After
	20	const { DynamicThreadPool } = require('poolifier/lib/dynamic')
	21	```
	22
	23	But you should always prefer just using
	24
	25	```js
	26	const { DynamicThreadPool } = require('poolifier')
	27	```
	28
	29	#### New type definitions for input data and response
	30
	31	For cluster and thread pools, you can now only send and receive serializable `JSON` data.
	32	_This is not a limitation by poolifier but NodeJS._
	33
	34	#### Public properties renaming
	35
	36	- Thread Pool's `numWorkers` is now `numberOfWorkers`
	37
	38	#### Internal (protected) methods renaming
	39
	40	Those methods are not intended to be used from final users
	41
	42	- `_chooseWorker` => `chooseWorker`
	43	- `_newWorker` => `newWorker`
	44	- `_execute` => `internalExecute`
	45	- `_chooseWorker` => `chooseWorker`
	46	- `_checkAlive` => `checkAlive`
	47	- `_run` => `run`
	48	- `_runAsync` => `runAsync`
	49
	50	## [1.1.0] - 2020-21-05
	51
	52	### Added
	53
	54	- ThreadWorker support async functions as option
	55	- Various external library patches
	56
	57	## [1.0.0] - 2020-24-01
	58
	59	### Added
	60
	61	- FixedThreadPool implementation
	62	- DynamicThreadPool implementation
	63	- WorkerThread implementation to improve developer experience