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