CHANGELOG.md

   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.1.0] - 2021-dd-mm
   9
  10 ### Breaking Changes
  11
  12 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
  13 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
  14 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
  15
  16 ## [2.0.2] - 2021-12-05
  17
  18 ### Bug fixes
  19
  20 - Fix `busy` event emission on fixed pool type
  21
  22 ## [2.0.1] - 2021-16-03
  23
  24 ### Bug fixes
  25
  26 - Check if pool options are properly set.
  27 - `busy` event is emitted on all pool types.
  28
  29 ## [2.0.0] - 2021-01-03
  30
  31 ### Bug fixes
  32
  33 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
  34
  35 ### Breaking Changes
  36
  37 - `FullPool` event is now renamed to `busy`.
  38 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
  39   _Find more details on our JSDoc._
  40
  41 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
  42
  43 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
  44
  45 ### Pool options types declaration merge
  46
  47 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
  48
  49 #### New `export` strategy
  50
  51 ```js
  52 // Before
  53 const DynamicThreadPool = require('poolifier/lib/dynamic')
  54 // After
  55 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
  56 ```
  57
  58 But you should always prefer just using
  59
  60 ```js
  61 const { DynamicThreadPool } = require('poolifier')
  62 ```
  63
  64 #### New type definitions for input data and response
  65
  66 For cluster worker and worker-thread pools, you can now only send and receive serializable data.
  67 _This is not a limitation by poolifier but NodeJS._
  68
  69 #### Public property replacements
  70
  71 `numWorkers` property is now `numberOfWorkers`
  72
  73 #### Internal (protected) properties and methods renaming
  74
  75 These properties are not intended for end users
  76
  77 - `id` => `nextMessageId`
  78
  79 These methods are not intended for end users
  80
  81 - `_chooseWorker` => `chooseWorker`
  82 - `_newWorker` => `createWorker`
  83 - `_execute` => `internalExecute`
  84 - `_chooseWorker` => `chooseWorker`
  85 - `_checkAlive` => `checkAlive`
  86 - `_run` => `run`
  87 - `_runAsync` => `runAsync`
  88
  89 ## [1.1.0] - 2020-21-05
  90
  91 ### Added
  92
  93 - ThreadWorker support async functions as option
  94 - Various external library patches
  95
  96 ## [1.0.0] - 2020-24-01
  97
  98 ### Added
  99
 100 - FixedThreadPool implementation
 101 - DynamicThreadPool implementation
 102 - WorkerThread implementation to improve developer experience