[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')
```

#### 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	#### Internal (protected) methods renaming
	30
	31	Those methods are not intended to be used from final users
	32
	33	- `_chooseWorker` => `chooseWorker`
	34	- `_newWorker` => `newWorker`
	35	- `_execute` => `internalExecute`
	36	- `_chooseWorker` => `chooseWorker`
	37	- `_checkAlive` => `checkAlive`
	38	- `_run` => `run`
	39	- `_runAsync` => `runAsync`
	40
	41	## [1.1.0] - 2020-21-05
	42
	43	### Added
	44
	45	- ThreadWorker support async functions as option
	46	- Various external library patches
	47
	48	## [1.0.0] - 2020-24-01
	49
	50	### Added
	51
	52	- FixedThreadPool implementation
	53	- DynamicThreadPool implementation
	54	- WorkerThread implementation to improve developer experience