From 191197c83806b047b83b1cedc93d0b26268e5d99 Mon Sep 17 00:00:00 2001 From: semantic-release-bot Date: Fri, 14 Apr 2023 09:55:06 +0000 Subject: [PATCH] chore(release): 3.0.0 [skip ci] MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ## [3.0.0](https://github.com/SkeLLLa/node-object-hash/compare/v2.3.10...v3.0.0) (2023-04-14) ### ⚠ BREAKING CHANGES * removed namespaces and refactored import format ### 🛠 Fixes * remove npm package lock ([a082cb9](https://github.com/SkeLLLa/node-object-hash/commit/a082cb973171e0813216365d51df148fc2791807)) * update lockfile ([e44e27b](https://github.com/SkeLLLa/node-object-hash/commit/e44e27bd25cbb1b1476b76e7b732c20681acf910)) * **ci:** update release action ([22b763e](https://github.com/SkeLLLa/node-object-hash/commit/22b763e107ce3039b5a458bc2131c23e8a618b9e)) ### 🚀 Features * typescript 5 migration ([debf48f](https://github.com/SkeLLLa/node-object-hash/commit/debf48fc0e8d3f2746455925e0d975b39873c4e1)) --- docs/CHANGELOG.md | 17 ++++++++++++++ docs/api/README.md | 4 ++-- docs/api/interfaces/hasher.Hashable.md | 4 ++-- docs/api/interfaces/hasher.Hasher.md | 8 +++---- docs/api/interfaces/hasher.HasherOptions.md | 12 +++++----- .../interfaces/objectSorter.CoerceOptions.md | 22 +++++++++---------- .../interfaces/objectSorter.SortOptions.md | 14 ++++++------ .../interfaces/objectSorter.SorterOptions.md | 8 +++---- .../interfaces/objectSorter.TrimOptions.md | 6 ++--- docs/api/modules/hasher.md | 4 ++-- docs/api/modules/objectSorter.md | 6 ++--- package.json | 2 +- 12 files changed, 62 insertions(+), 45 deletions(-) create mode 100644 docs/CHANGELOG.md diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md new file mode 100644 index 0000000..19fb0b1 --- /dev/null +++ b/docs/CHANGELOG.md @@ -0,0 +1,17 @@ +## [3.0.0](https://github.com/SkeLLLa/node-object-hash/compare/v2.3.10...v3.0.0) (2023-04-14) + + +### ⚠ BREAKING CHANGES + +* removed namespaces and refactored import format + +### 🛠 Fixes + +* remove npm package lock ([a082cb9](https://github.com/SkeLLLa/node-object-hash/commit/a082cb973171e0813216365d51df148fc2791807)) +* update lockfile ([e44e27b](https://github.com/SkeLLLa/node-object-hash/commit/e44e27bd25cbb1b1476b76e7b732c20681acf910)) +* **ci:** update release action ([22b763e](https://github.com/SkeLLLa/node-object-hash/commit/22b763e107ce3039b5a458bc2131c23e8a618b9e)) + + +### 🚀 Features + +* typescript 5 migration ([debf48f](https://github.com/SkeLLLa/node-object-hash/commit/debf48fc0e8d3f2746455925e0d975b39873c4e1)) diff --git a/docs/api/README.md b/docs/api/README.md index 1c6e1c7..2cc3623 100644 --- a/docs/api/README.md +++ b/docs/api/README.md @@ -1,7 +1,7 @@ -Node object hash - # Node object hash +# # Node object hash + ## Table of contents ### Modules diff --git a/docs/api/interfaces/hasher.Hashable.md b/docs/api/interfaces/hasher.Hashable.md index 44cebdb..72808aa 100644 --- a/docs/api/interfaces/hasher.Hashable.md +++ b/docs/api/interfaces/hasher.Hashable.md @@ -1,4 +1,4 @@ -[Node object hash](../README.md) / [hasher](../modules/hasher.md) / Hashable +[# Node object hash](../README.md) / [hasher](../modules/hasher.md) / Hashable # Interface: Hashable @@ -30,4 +30,4 @@ with the function toHash that return the same value will have the same hash #### Defined in -[hasher.ts:38](https://github.com/SkeLLLa/node-object-hash/blob/56d25e0/src/hasher.ts#L38) +[hasher.ts:38](https://github.com/SkeLLLa/node-object-hash/blob/22b763e/src/hasher.ts#L38) diff --git a/docs/api/interfaces/hasher.Hasher.md b/docs/api/interfaces/hasher.Hasher.md index 8857332..2ca4860 100644 --- a/docs/api/interfaces/hasher.Hasher.md +++ b/docs/api/interfaces/hasher.Hasher.md @@ -1,4 +1,4 @@ -[Node object hash](../README.md) / [hasher](../modules/hasher.md) / Hasher +[# Node object hash](../README.md) / [hasher](../modules/hasher.md) / Hasher # Interface: Hasher @@ -41,7 +41,7 @@ hash string of an object #### Defined in -[hasher.ts:47](https://github.com/SkeLLLa/node-object-hash/blob/56d25e0/src/hasher.ts#L47) +[hasher.ts:47](https://github.com/SkeLLLa/node-object-hash/blob/22b763e/src/hasher.ts#L47) --- @@ -65,7 +65,7 @@ sorted string from an object #### Defined in -[hasher.ts:53](https://github.com/SkeLLLa/node-object-hash/blob/56d25e0/src/hasher.ts#L53) +[hasher.ts:53](https://github.com/SkeLLLa/node-object-hash/blob/22b763e/src/hasher.ts#L53) --- @@ -93,4 +93,4 @@ sorted string from an object #### Defined in -[hasher.ts:60](https://github.com/SkeLLLa/node-object-hash/blob/56d25e0/src/hasher.ts#L60) +[hasher.ts:60](https://github.com/SkeLLLa/node-object-hash/blob/22b763e/src/hasher.ts#L60) diff --git a/docs/api/interfaces/hasher.HasherOptions.md b/docs/api/interfaces/hasher.HasherOptions.md index a94e96b..ee44287 100644 --- a/docs/api/interfaces/hasher.HasherOptions.md +++ b/docs/api/interfaces/hasher.HasherOptions.md @@ -1,4 +1,4 @@ -[Node object hash](../README.md) / [hasher](../modules/hasher.md) / HasherOptions +[# Node object hash](../README.md) / [hasher](../modules/hasher.md) / HasherOptions # Interface: HasherOptions @@ -38,7 +38,7 @@ Hash algorithm to use #### Defined in -[hasher.ts:24](https://github.com/SkeLLLa/node-object-hash/blob/56d25e0/src/hasher.ts#L24) +[hasher.ts:24](https://github.com/SkeLLLa/node-object-hash/blob/22b763e/src/hasher.ts#L24) --- @@ -61,7 +61,7 @@ true; #### Defined in -[objectSorter.ts:170](https://github.com/SkeLLLa/node-object-hash/blob/56d25e0/src/objectSorter.ts#L170) +[objectSorter.ts:170](https://github.com/SkeLLLa/node-object-hash/blob/22b763e/src/objectSorter.ts#L170) --- @@ -79,7 +79,7 @@ String encoding for hash #### Defined in -[hasher.ts:29](https://github.com/SkeLLLa/node-object-hash/blob/56d25e0/src/hasher.ts#L29) +[hasher.ts:29](https://github.com/SkeLLLa/node-object-hash/blob/22b763e/src/hasher.ts#L29) --- @@ -102,7 +102,7 @@ true; #### Defined in -[objectSorter.ts:176](https://github.com/SkeLLLa/node-object-hash/blob/56d25e0/src/objectSorter.ts#L176) +[objectSorter.ts:176](https://github.com/SkeLLLa/node-object-hash/blob/22b763e/src/objectSorter.ts#L176) --- @@ -125,4 +125,4 @@ false; #### Defined in -[objectSorter.ts:182](https://github.com/SkeLLLa/node-object-hash/blob/56d25e0/src/objectSorter.ts#L182) +[objectSorter.ts:182](https://github.com/SkeLLLa/node-object-hash/blob/22b763e/src/objectSorter.ts#L182) diff --git a/docs/api/interfaces/objectSorter.CoerceOptions.md b/docs/api/interfaces/objectSorter.CoerceOptions.md index a38b90a..de4130e 100644 --- a/docs/api/interfaces/objectSorter.CoerceOptions.md +++ b/docs/api/interfaces/objectSorter.CoerceOptions.md @@ -1,4 +1,4 @@ -[Node object hash](../README.md) / [objectSorter](../modules/objectSorter.md) / CoerceOptions +[# Node object hash](../README.md) / [objectSorter](../modules/objectSorter.md) / CoerceOptions # Interface: CoerceOptions @@ -51,7 +51,7 @@ true; #### Defined in -[objectSorter.ts:43](https://github.com/SkeLLLa/node-object-hash/blob/56d25e0/src/objectSorter.ts#L43) +[objectSorter.ts:43](https://github.com/SkeLLLa/node-object-hash/blob/22b763e/src/objectSorter.ts#L43) --- @@ -85,7 +85,7 @@ true; #### Defined in -[objectSorter.ts:21](https://github.com/SkeLLLa/node-object-hash/blob/56d25e0/src/objectSorter.ts#L21) +[objectSorter.ts:21](https://github.com/SkeLLLa/node-object-hash/blob/22b763e/src/objectSorter.ts#L21) --- @@ -115,7 +115,7 @@ true; #### Defined in -[objectSorter.ts:105](https://github.com/SkeLLLa/node-object-hash/blob/56d25e0/src/objectSorter.ts#L105) +[objectSorter.ts:105](https://github.com/SkeLLLa/node-object-hash/blob/22b763e/src/objectSorter.ts#L105) --- @@ -145,7 +145,7 @@ true; #### Defined in -[objectSorter.ts:96](https://github.com/SkeLLLa/node-object-hash/blob/56d25e0/src/objectSorter.ts#L96) +[objectSorter.ts:96](https://github.com/SkeLLLa/node-object-hash/blob/22b763e/src/objectSorter.ts#L96) --- @@ -177,7 +177,7 @@ true; #### Defined in -[objectSorter.ts:76](https://github.com/SkeLLLa/node-object-hash/blob/56d25e0/src/objectSorter.ts#L76) +[objectSorter.ts:76](https://github.com/SkeLLLa/node-object-hash/blob/22b763e/src/objectSorter.ts#L76) --- @@ -209,7 +209,7 @@ true; #### Defined in -[objectSorter.ts:32](https://github.com/SkeLLLa/node-object-hash/blob/56d25e0/src/objectSorter.ts#L32) +[objectSorter.ts:32](https://github.com/SkeLLLa/node-object-hash/blob/22b763e/src/objectSorter.ts#L32) --- @@ -239,7 +239,7 @@ true; #### Defined in -[objectSorter.ts:114](https://github.com/SkeLLLa/node-object-hash/blob/56d25e0/src/objectSorter.ts#L114) +[objectSorter.ts:114](https://github.com/SkeLLLa/node-object-hash/blob/22b763e/src/objectSorter.ts#L114) --- @@ -271,7 +271,7 @@ true; #### Defined in -[objectSorter.ts:54](https://github.com/SkeLLLa/node-object-hash/blob/56d25e0/src/objectSorter.ts#L54) +[objectSorter.ts:54](https://github.com/SkeLLLa/node-object-hash/blob/22b763e/src/objectSorter.ts#L54) --- @@ -303,7 +303,7 @@ true; #### Defined in -[objectSorter.ts:87](https://github.com/SkeLLLa/node-object-hash/blob/56d25e0/src/objectSorter.ts#L87) +[objectSorter.ts:87](https://github.com/SkeLLLa/node-object-hash/blob/22b763e/src/objectSorter.ts#L87) --- @@ -335,4 +335,4 @@ true; #### Defined in -[objectSorter.ts:65](https://github.com/SkeLLLa/node-object-hash/blob/56d25e0/src/objectSorter.ts#L65) +[objectSorter.ts:65](https://github.com/SkeLLLa/node-object-hash/blob/22b763e/src/objectSorter.ts#L65) diff --git a/docs/api/interfaces/objectSorter.SortOptions.md b/docs/api/interfaces/objectSorter.SortOptions.md index 889e9a3..0987b66 100644 --- a/docs/api/interfaces/objectSorter.SortOptions.md +++ b/docs/api/interfaces/objectSorter.SortOptions.md @@ -1,4 +1,4 @@ -[Node object hash](../README.md) / [objectSorter](../modules/objectSorter.md) / SortOptions +[# Node object hash](../README.md) / [objectSorter](../modules/objectSorter.md) / SortOptions # Interface: SortOptions @@ -27,7 +27,7 @@ If `true` sort array entries before hash #### Defined in -[objectSorter.ts:124](https://github.com/SkeLLLa/node-object-hash/blob/56d25e0/src/objectSorter.ts#L124) +[objectSorter.ts:124](https://github.com/SkeLLLa/node-object-hash/blob/22b763e/src/objectSorter.ts#L124) --- @@ -39,7 +39,7 @@ If `true` sort BigInt entries before hash #### Defined in -[objectSorter.ts:144](https://github.com/SkeLLLa/node-object-hash/blob/56d25e0/src/objectSorter.ts#L144) +[objectSorter.ts:144](https://github.com/SkeLLLa/node-object-hash/blob/22b763e/src/objectSorter.ts#L144) --- @@ -51,7 +51,7 @@ If `true` sort map entries before hash #### Defined in -[objectSorter.ts:140](https://github.com/SkeLLLa/node-object-hash/blob/56d25e0/src/objectSorter.ts#L140) +[objectSorter.ts:140](https://github.com/SkeLLLa/node-object-hash/blob/22b763e/src/objectSorter.ts#L140) --- @@ -63,7 +63,7 @@ If `true` sort object entries before hash #### Defined in -[objectSorter.ts:132](https://github.com/SkeLLLa/node-object-hash/blob/56d25e0/src/objectSorter.ts#L132) +[objectSorter.ts:132](https://github.com/SkeLLLa/node-object-hash/blob/22b763e/src/objectSorter.ts#L132) --- @@ -75,7 +75,7 @@ If `true` sort set entries before hash #### Defined in -[objectSorter.ts:136](https://github.com/SkeLLLa/node-object-hash/blob/56d25e0/src/objectSorter.ts#L136) +[objectSorter.ts:136](https://github.com/SkeLLLa/node-object-hash/blob/22b763e/src/objectSorter.ts#L136) --- @@ -87,4 +87,4 @@ If `true` sort TypedArray entries before hash #### Defined in -[objectSorter.ts:128](https://github.com/SkeLLLa/node-object-hash/blob/56d25e0/src/objectSorter.ts#L128) +[objectSorter.ts:128](https://github.com/SkeLLLa/node-object-hash/blob/22b763e/src/objectSorter.ts#L128) diff --git a/docs/api/interfaces/objectSorter.SorterOptions.md b/docs/api/interfaces/objectSorter.SorterOptions.md index 71dbb5c..c1956b9 100644 --- a/docs/api/interfaces/objectSorter.SorterOptions.md +++ b/docs/api/interfaces/objectSorter.SorterOptions.md @@ -1,4 +1,4 @@ -[Node object hash](../README.md) / [objectSorter](../modules/objectSorter.md) / SorterOptions +[# Node object hash](../README.md) / [objectSorter](../modules/objectSorter.md) / SorterOptions # Interface: SorterOptions @@ -37,7 +37,7 @@ true; #### Defined in -[objectSorter.ts:170](https://github.com/SkeLLLa/node-object-hash/blob/56d25e0/src/objectSorter.ts#L170) +[objectSorter.ts:170](https://github.com/SkeLLLa/node-object-hash/blob/22b763e/src/objectSorter.ts#L170) --- @@ -56,7 +56,7 @@ true; #### Defined in -[objectSorter.ts:176](https://github.com/SkeLLLa/node-object-hash/blob/56d25e0/src/objectSorter.ts#L176) +[objectSorter.ts:176](https://github.com/SkeLLLa/node-object-hash/blob/22b763e/src/objectSorter.ts#L176) --- @@ -75,4 +75,4 @@ false; #### Defined in -[objectSorter.ts:182](https://github.com/SkeLLLa/node-object-hash/blob/56d25e0/src/objectSorter.ts#L182) +[objectSorter.ts:182](https://github.com/SkeLLLa/node-object-hash/blob/22b763e/src/objectSorter.ts#L182) diff --git a/docs/api/interfaces/objectSorter.TrimOptions.md b/docs/api/interfaces/objectSorter.TrimOptions.md index d6dbc19..252100f 100644 --- a/docs/api/interfaces/objectSorter.TrimOptions.md +++ b/docs/api/interfaces/objectSorter.TrimOptions.md @@ -1,4 +1,4 @@ -[Node object hash](../README.md) / [objectSorter](../modules/objectSorter.md) / TrimOptions +[# Node object hash](../README.md) / [objectSorter](../modules/objectSorter.md) / TrimOptions # Interface: TrimOptions @@ -23,7 +23,7 @@ If `true` replaces multiple space with one and trims whitespaces in function bod #### Defined in -[objectSorter.ts:158](https://github.com/SkeLLLa/node-object-hash/blob/56d25e0/src/objectSorter.ts#L158) +[objectSorter.ts:158](https://github.com/SkeLLLa/node-object-hash/blob/22b763e/src/objectSorter.ts#L158) --- @@ -35,4 +35,4 @@ If `true` replaces multiple space with one and trims whitespaces in strings #### Defined in -[objectSorter.ts:154](https://github.com/SkeLLLa/node-object-hash/blob/56d25e0/src/objectSorter.ts#L154) +[objectSorter.ts:154](https://github.com/SkeLLLa/node-object-hash/blob/22b763e/src/objectSorter.ts#L154) diff --git a/docs/api/modules/hasher.md b/docs/api/modules/hasher.md index dea8bb1..4167173 100644 --- a/docs/api/modules/hasher.md +++ b/docs/api/modules/hasher.md @@ -1,4 +1,4 @@ -[Node object hash](../README.md) / hasher +[# Node object hash](../README.md) / hasher # Module: hasher @@ -36,4 +36,4 @@ hasher instance #### Defined in -[hasher.ts:68](https://github.com/SkeLLLa/node-object-hash/blob/56d25e0/src/hasher.ts#L68) +[hasher.ts:68](https://github.com/SkeLLLa/node-object-hash/blob/22b763e/src/hasher.ts#L68) diff --git a/docs/api/modules/objectSorter.md b/docs/api/modules/objectSorter.md index 25ac6b9..f35a4d8 100644 --- a/docs/api/modules/objectSorter.md +++ b/docs/api/modules/objectSorter.md @@ -1,4 +1,4 @@ -[Node object hash](../README.md) / objectSorter +[# Node object hash](../README.md) / objectSorter # Module: objectSorter @@ -47,7 +47,7 @@ #### Defined in -[objectSorter.ts:185](https://github.com/SkeLLLa/node-object-hash/blob/56d25e0/src/objectSorter.ts#L185) +[objectSorter.ts:185](https://github.com/SkeLLLa/node-object-hash/blob/22b763e/src/objectSorter.ts#L185) ## Functions @@ -71,4 +71,4 @@ function that transforms object to strings #### Defined in -[objectSorter.ts:192](https://github.com/SkeLLLa/node-object-hash/blob/56d25e0/src/objectSorter.ts#L192) +[objectSorter.ts:192](https://github.com/SkeLLLa/node-object-hash/blob/22b763e/src/objectSorter.ts#L192) diff --git a/package.json b/package.json index 0e01590..03fcfe2 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "node-object-hash", - "version": "2.3.10", + "version": "3.0.0", "description": "Node.js object hash library with properties/arrays sorting to provide constant hashes", "keywords": [ "hash",