Skip to content

Commit 0a3e329

Browse files
chore(release): 3.0.0 [skip ci]
# [3.0.0](v2.1.1...v3.0.0) (2022-09-09) ### Bug Fixes * **Array:** Add support for dash in array name ([b001403](b001403)), closes [#98](#98) * **Array:** Fix array not properly async ([7bfd98d](7bfd98d)) * **ArrayInfo:** Returns type of isValid ([d206098](d206098)) * **Array:** Support dot and number in name ([eb89a42](eb89a42)), closes [#95](#95) * **Concurrency:** Fix issue with concurrent push from different sources ([daae2bb](daae2bb)), closes [#484](#484) * **Config:** put proper default for ConfigWithAdapter ([dbb3b7b](dbb3b7b)) * **Convention:** Fixed quotes ([7126cad](7126cad)) * **Docs:** Be sure the doc contains Config ([c453c5d](c453c5d)) * **getIndex:** Improve documentation ([17ba435](17ba435)) * **HumanReadable:** Fix missing humanreadable ([4a2d198](4a2d198)) * **JsonAdapter:** Don't override the data property ([43898d5](43898d5)) * **Packaging:** Add type to package. ([983ea99](983ea99)), closes [#58](#58) [#57](#57) * **README:** Update documentation ([d66d712](d66d712)) * **README:** Update documentation ([ba42a83](ba42a83)), closes [#90](#90) [#85](#85) * **Separator:** Fix still using the slash as separator. ([c4c18b8](c4c18b8)) ### Features * **Adapter:** Add concept of adapter to read and write data ([9a31abc](9a31abc)) * **Adapter:** Let the user decide what adapter to use if they want to tweak the inner working ([975a653](975a653)), closes [#448](#448) * add some array utils ([c85618e](c85618e)) * **Array:** Add support for nested array ([57c049f](57c049f)), closes [#422](#422) [#417](#417) * **Async:** All the method are now async/await ([a6a4a8d](a6a4a8d)), closes [#171](#171) * **Async:** Make the whole library async ([b99d784](b99d784)), closes [#444](#444) * **AtomicFileAdapter:** Add support for fsync ([e4760cb](e4760cb)) * **Config:** Add Config file to setup the Database ([3915aee](3915aee)) * **Configuration:** Force giving a config object to the constructor ([8e415e6](8e415e6)) * **Date:** Add support for serializing and deserializing date type ([e62e792](e62e792)), closes [#362](#362) * **Exists:** Add exits method ([35152a2](35152a2)), closes [#19](#19) * **filename:** Support non json file extensions ([6be9a1d](6be9a1d)) * **Filter:** Add filtering feature ([0f7d276](0f7d276)) * **find:** Add find feature ([bd7ab4c](bd7ab4c)), closes [#17](#17) * **FSYNC:** Optional fsync when saving the database ([8ae82ab](8ae82ab)), closes [#372](#372) * **getIndex:** Support Numerical id ([d2e88ea](d2e88ea)) * **GetIndexValue:** Get index of a value in an array ([35d1807](35d1807)), closes [#191](#191) * **Packaging:** Use es6 module packaging ([4487c4b](4487c4b)) * **typing:** Add basic typing to the lib for TS ([db8ab77](db8ab77)) ### Performance Improvements * **Concurrency:** Be sure that only one read or one write can be done at the same time ([1cf0038](1cf0038)) * **Config:** Easier way to import the configuration of JsonDB ([e371b71](e371b71)) * **Errors:** Export errors for easier error management in other projects ([60c90f8](60c90f8)), closes [#479](#479) ### BREAKING CHANGES * **Async:** Every method of the library is now async and returns a promise. * **Configuration:** We now need to receive the JsonDBConfig object in the constructor * **Packaging:** The default export has been removed. You need to do a deconstruction import to load the library now. import JsonDB from 'node-json-db' becomes import {JsonDB} from 'node-json-db'
1 parent 59ef534 commit 0a3e329

File tree

2 files changed

+63
-1
lines changed

2 files changed

+63
-1
lines changed

CHANGELOG.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,65 @@
1+
# [3.0.0](https://github.com/Belphemur/node-json-db/compare/v2.1.1...v3.0.0) (2022-09-09)
2+
3+
4+
### Bug Fixes
5+
6+
* **Array:** Add support for dash in array name ([b001403](https://github.com/Belphemur/node-json-db/commit/b001403fccc0dfa6c0be3219268d8f1a548eade2)), closes [#98](https://github.com/Belphemur/node-json-db/issues/98)
7+
* **Array:** Fix array not properly async ([7bfd98d](https://github.com/Belphemur/node-json-db/commit/7bfd98d20db96805f7401f350c367c3a4bffcd56))
8+
* **ArrayInfo:** Returns type of isValid ([d206098](https://github.com/Belphemur/node-json-db/commit/d20609879e73ef10ba026ecdd73b56ddd5fe4316))
9+
* **Array:** Support dot and number in name ([eb89a42](https://github.com/Belphemur/node-json-db/commit/eb89a42e1203804e5a8c3e122e4cc62c47bb9c6e)), closes [#95](https://github.com/Belphemur/node-json-db/issues/95)
10+
* **Concurrency:** Fix issue with concurrent push from different sources ([daae2bb](https://github.com/Belphemur/node-json-db/commit/daae2bb6310d79c7479e4a50b9bde63ac93d0d02)), closes [#484](https://github.com/Belphemur/node-json-db/issues/484)
11+
* **Config:** put proper default for ConfigWithAdapter ([dbb3b7b](https://github.com/Belphemur/node-json-db/commit/dbb3b7b7f018a71ec9357286f7e6cf72ecbc427d))
12+
* **Convention:** Fixed quotes ([7126cad](https://github.com/Belphemur/node-json-db/commit/7126cadb23c5e71bf427deea41a689a6cd3d8006))
13+
* **Docs:** Be sure the doc contains Config ([c453c5d](https://github.com/Belphemur/node-json-db/commit/c453c5d6b54ee7f25a0c084b5473b9019a6e0edc))
14+
* **getIndex:** Improve documentation ([17ba435](https://github.com/Belphemur/node-json-db/commit/17ba4359e61a57144f5ef98f3dd398d2a0e5e7b6))
15+
* **HumanReadable:** Fix missing humanreadable ([4a2d198](https://github.com/Belphemur/node-json-db/commit/4a2d198be04ba3cded9bf56577c991d349f0efe4))
16+
* **JsonAdapter:** Don't override the data property ([43898d5](https://github.com/Belphemur/node-json-db/commit/43898d5fa3aa5e474bc5c4a378985e393d2d92ba))
17+
* **Packaging:** Add type to package. ([983ea99](https://github.com/Belphemur/node-json-db/commit/983ea99218aa7cbd9dd2593a8200c5ac1af70fa6)), closes [#58](https://github.com/Belphemur/node-json-db/issues/58) [#57](https://github.com/Belphemur/node-json-db/issues/57)
18+
* **README:** Update documentation ([d66d712](https://github.com/Belphemur/node-json-db/commit/d66d712fb8bffbda3916109940792617c53814b6))
19+
* **README:** Update documentation ([ba42a83](https://github.com/Belphemur/node-json-db/commit/ba42a834901a15a1d8b61029fee1c248a92fb23f)), closes [#90](https://github.com/Belphemur/node-json-db/issues/90) [#85](https://github.com/Belphemur/node-json-db/issues/85)
20+
* **Separator:** Fix still using the slash as separator. ([c4c18b8](https://github.com/Belphemur/node-json-db/commit/c4c18b8cece571b93ceef240c54bc585695b7112))
21+
22+
23+
### Features
24+
25+
* **Adapter:** Add concept of adapter to read and write data ([9a31abc](https://github.com/Belphemur/node-json-db/commit/9a31abc5edc93c6f631ec8f7458daefdc0265ebd))
26+
* **Adapter:** Let the user decide what adapter to use if they want to tweak the inner working ([975a653](https://github.com/Belphemur/node-json-db/commit/975a653d547c11b142490d385d18bdc4283bea9c)), closes [#448](https://github.com/Belphemur/node-json-db/issues/448)
27+
* add some array utils ([c85618e](https://github.com/Belphemur/node-json-db/commit/c85618e19a422032b539d56f922cc097471b07b1))
28+
* **Array:** Add support for nested array ([57c049f](https://github.com/Belphemur/node-json-db/commit/57c049f19cbec665184a8ad2740bc2bf7b309ccd)), closes [#422](https://github.com/Belphemur/node-json-db/issues/422) [#417](https://github.com/Belphemur/node-json-db/issues/417)
29+
* **Async:** All the method are now async/await ([a6a4a8d](https://github.com/Belphemur/node-json-db/commit/a6a4a8d962f6478e466c23653bddb2c15ced7eec)), closes [#171](https://github.com/Belphemur/node-json-db/issues/171)
30+
* **Async:** Make the whole library async ([b99d784](https://github.com/Belphemur/node-json-db/commit/b99d7848d5b016aada2b19eed14347c63cad087e)), closes [#444](https://github.com/Belphemur/node-json-db/issues/444)
31+
* **AtomicFileAdapter:** Add support for fsync ([e4760cb](https://github.com/Belphemur/node-json-db/commit/e4760cbc2f23fc8aedfac8130f8d9cf75ae302c7))
32+
* **Config:** Add Config file to setup the Database ([3915aee](https://github.com/Belphemur/node-json-db/commit/3915aeeaa93cefc452c800fb4ce1ae2bd83f8d67))
33+
* **Configuration:** Force giving a config object to the constructor ([8e415e6](https://github.com/Belphemur/node-json-db/commit/8e415e673ab49e78876ba3412ce5fbe388ce1b0c))
34+
* **Date:** Add support for serializing and deserializing date type ([e62e792](https://github.com/Belphemur/node-json-db/commit/e62e7925dcdf8c8ba701aedb321ef8ded9ca44da)), closes [#362](https://github.com/Belphemur/node-json-db/issues/362)
35+
* **Exists:** Add exits method ([35152a2](https://github.com/Belphemur/node-json-db/commit/35152a28a0e963121daeea7d0f66248239344401)), closes [#19](https://github.com/Belphemur/node-json-db/issues/19)
36+
* **filename:** Support non json file extensions ([6be9a1d](https://github.com/Belphemur/node-json-db/commit/6be9a1da44b18834f4e4ccdddaf5697b11309630))
37+
* **Filter:** Add filtering feature ([0f7d276](https://github.com/Belphemur/node-json-db/commit/0f7d276b9c4d281a2511a67fe06184a7c8614023))
38+
* **find:** Add find feature ([bd7ab4c](https://github.com/Belphemur/node-json-db/commit/bd7ab4c485d0ca83d294b6a74692051af4ab68f7)), closes [#17](https://github.com/Belphemur/node-json-db/issues/17)
39+
* **FSYNC:** Optional fsync when saving the database ([8ae82ab](https://github.com/Belphemur/node-json-db/commit/8ae82abcd6d2c3412d53a36dd78f0ad90cd57127)), closes [#372](https://github.com/Belphemur/node-json-db/issues/372)
40+
* **getIndex:** Support Numerical id ([d2e88ea](https://github.com/Belphemur/node-json-db/commit/d2e88ea0ef834568657084da0c130e0192222213))
41+
* **GetIndexValue:** Get index of a value in an array ([35d1807](https://github.com/Belphemur/node-json-db/commit/35d18070ace6067f32fcb150c5af246dcf925ce2)), closes [#191](https://github.com/Belphemur/node-json-db/issues/191)
42+
* **Packaging:** Use es6 module packaging ([4487c4b](https://github.com/Belphemur/node-json-db/commit/4487c4bf418b535756d10a9be8eb1dc8bb2e92c9))
43+
* **typing:** Add basic typing to the lib for TS ([db8ab77](https://github.com/Belphemur/node-json-db/commit/db8ab77c13c2226991d8150381e470daf2ab4eb0))
44+
45+
46+
### Performance Improvements
47+
48+
* **Concurrency:** Be sure that only one read or one write can be done at the same time ([1cf0038](https://github.com/Belphemur/node-json-db/commit/1cf0038fc344ab1c1edd3f45ad3660d7ba04daaa))
49+
* **Config:** Easier way to import the configuration of JsonDB ([e371b71](https://github.com/Belphemur/node-json-db/commit/e371b718c57ce3d8ca678d942c2e14f1aa4e66fc))
50+
* **Errors:** Export errors for easier error management in other projects ([60c90f8](https://github.com/Belphemur/node-json-db/commit/60c90f862a840576b90af7be375dfc2ed7c0777d)), closes [#479](https://github.com/Belphemur/node-json-db/issues/479)
51+
52+
53+
### BREAKING CHANGES
54+
55+
* **Async:** Every method of the library is now async and returns a promise.
56+
* **Configuration:** We now need to receive the JsonDBConfig object in the constructor
57+
* **Packaging:** The default export has been removed. You need to do a deconstruction import to load the library now.
58+
59+
import JsonDB from 'node-json-db'
60+
becomes
61+
import {JsonDB} from 'node-json-db'
62+
163
## [2.1.1](https://github.com/Belphemur/node-json-db/compare/v2.1.0...v2.1.1) (2022-08-26)
264

365

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "node-json-db",
3-
"version": "2.1.1",
3+
"version": "3.0.0",
44
"description": "Database using JSON file as storage for Node.JS",
55
"main": "dist/JsonDB.js",
66
"types": "dist/JsonDB.d.ts",

0 commit comments

Comments
 (0)