@sv443-network/coreutils 3.2.0 → 3.4.0

package/CHANGELOG.md

@@ -1,5 +1,39 @@
 # @sv443-network/coreutils
 
+## 3.4.0
+
+### Minor Changes
+
+- 7e5c0b6: `Debouncer` and `debounce` now have an extra parameter of type `NanoEmitterOptions` to customize the underlying `NanoEmitter` instance.
+- 2a04a7d: Added function `createRecurringTask()` as a "batteries included" alternative to `setImmediateTimeoutLoop()` and `setImmediateInterval()`, with more ways to control task execution and aborting.
+
+### Patch Changes
+
+- 328c460: Fix internal event emission problems in `Debouncer`
+
+## 3.3.0
+
+### Minor Changes
+
+- 4af3dda: `DataStore` now extends `NanoEmitter` to allow for much better event-driven programming using the methods `on()`, `once()`, `onMulti()`, etc.
+  Currently, the following events are emitted by the `DataStore` class:
+
+  | Name             | Description                                                                                                                                                                                              |
+  | :--------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+  | `loadData`       | Whenever the data is loaded from persistent storage with `DataStore.loadData()`.                                                                                                                         |
+  | `updateData`     | When the data is updated with `DataStore.setData()` or `DataStore.runMigrations()`.                                                                                                                      |
+  | `updateDataSync` | When the memory cache was updated with `DataStore.setData()`, before the data is saved to persistent storage. Not emitted if `memoryCache` is set to `false`.                                            |
+  | `migrateData`    | For every called migration function with the resulting data.                                                                                                                                             |
+  | `migrateId`      | For every successfully migrated old ID. Gets passed the old and new ID.                                                                                                                                  |
+  | `setDefaultData` | Whenever the data is reset to the default value with `DataStore.saveDefaultData()` (will not be called on the initial population of persistent storage with the default data in `DataStore.loadData()`). |
+  | `deleteData`     | After the data was deleted from persistent storage with `DataStore.deleteData()`.                                                                                                                        |
+  | `error`          | When an error occurs at any point.                                                                                                                                                                       |
+  | `migrationError` | Only when an error occurs during a migration function.                                                                                                                                                   |
+
+### Patch Changes
+
+- f7dbacf: Fixed DataStore error handling inconsistencies.
+
 ## 3.2.0
 
 ### Minor Changes

package/README.md

@@ -35,6 +35,7 @@ Intended to be used in conjunction with [`@sv443-network/userutils`](https://git
     - 🔷 [`type DataStoreOptions`](./docs.md#type-datastoreoptions) - Options for the data store
     - 🔷 [`type DataMigrationsDict`](./docs.md#type-datamigrationsdict) - Dictionary of data migration functions
     - 🔷 [`type DataStoreData`](./docs.md#type-datastoredata) - The type of the serializable data
+    - 🔷 [`type DataStoreEventMap`](./docs.md#type-datastoreeventmap) - Map of DataStore events
   - 🟧 [`class DataStoreSerializer`](./docs.md#class-datastoreserializer) - Serializes and deserializes data for multiple DataStore instances
     - 🔷 [`type DataStoreSerializerOptions`](./docs.md#type-datastoreserializeroptions) - Options for the DataStoreSerializer
     - 🔷 [`type LoadStoresDataResult`](./docs.md#type-loadstoresdataresult) - Result of calling [`loadStoresData()`](./docs.md#datastoreserializer-loadstoresdata)
@@ -83,6 +84,8 @@ Intended to be used in conjunction with [`@sv443-network/userutils`](https://git
   - 🟣 [`function pureObj()`](./docs.md#function-pureobj) - Applies an object's props to a null object (object without prototype chain) or just returns a new null object
   - 🟣 [`function setImmediateInterval()`](./docs.md#function-setimmediateinterval) - Like `setInterval()`, but instantly calls the callback and supports passing an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal)
   - 🟣 [`function setImmediateTimeoutLoop()`](./docs.md#function-setimmediatetimeoutloop) - Like a recursive `setTimeout()` loop, but instantly calls the callback and supports passing an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal)
+  - 🟣 [`function createRecurringTask()`](./docs.md#function-createrecurringtask) - Similar to `setImmediateTimeoutLoop()`, but with many more ways of controlling execution.
+    - 🔷 [`type RecurringTaskOptions`](./docs.md#type-recurringtaskoptions) - Options for the `createRecurringTask()` function.
   - 🟣 [`function scheduleExit()`](./docs.md#function-scheduleexit) - Schedules a process exit after the next event loop tick, to allow operations like IO writes to finish.
 - [**NanoEmitter:**](./docs.md#nanoemitter)
   - 🟧 [`class NanoEmitter`](./docs.md#class-nanoemitter) - Simple, lightweight event emitter class that can be used in both FP and OOP, inspired by [`EventEmitter` from `node:events`](https://nodejs.org/api/events.html#class-eventemitter), based on [`nanoevents`](https://npmjs.com/package/nanoevents)