From 056435d287e23b8e96501a5000038f5722247c9a Mon Sep 17 00:00:00 2001 From: Release Bot <2273103+SkeLLLa@users.noreply.github.com> Date: Mon, 22 Feb 2021 16:20:36 +0000 Subject: [PATCH] chore(release): 2.2.0 --- CHANGELOG.md | 14 ++++++ VERSION | 2 +- docs/README.md | 4 +- docs/interfaces/hasher.export_.hashable.md | 4 +- docs/interfaces/hasher.export_.hasher.md | 8 ++-- .../hasher.export_.hasheroptions.md | 12 +++--- docs/interfaces/hasher.hashable.md | 4 +- docs/interfaces/hasher.hasher-1.md | 8 ++-- docs/interfaces/hasher.hasheroptions.md | 12 +++--- docs/interfaces/objectsorter.coerceoptions.md | 43 ++++++++++++++----- .../objectsorter.export_.coerceoptions.md | 43 ++++++++++++++----- .../objectsorter.export_.sorteroptions.md | 8 ++-- .../objectsorter.export_.sortoptions.md | 21 ++++++--- .../objectsorter.export_.trimoptions.md | 6 +-- docs/interfaces/objectsorter.sorteroptions.md | 8 ++-- docs/interfaces/objectsorter.sortoptions.md | 21 ++++++--- docs/interfaces/objectsorter.trimoptions.md | 6 +-- docs/modules/hasher.export_.md | 2 +- docs/modules/hasher.md | 4 +- docs/modules/objectsorter.export_.md | 4 +- docs/modules/objectsorter.md | 6 +-- package-lock.json | 2 +- package.json | 2 +- 23 files changed, 161 insertions(+), 83 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8368b21..7ba2894 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,20 @@ All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines. +## [2.2.0](https://github.com/SkeLLLa/node-object-hash/compare/v2.1.2...v2.2.0) (2021-02-22) + + +### Features + +* add bigint support ([544d97e](https://github.com/SkeLLLa/node-object-hash/commit/544d97e9712961effae0a6940357bb1f8b9adcc6)) + + +### Bug fixes + +* coerce option for bigint ([ca2f87c](https://github.com/SkeLLLa/node-object-hash/commit/ca2f87c7af8270ec5ce89de1bb166257000ffca1)) +* typo in doc ([d9d7e24](https://github.com/SkeLLLa/node-object-hash/commit/d9d7e24f2b45e5b14c92a01da648f6ad9daf8427)) +* **typos:** fix typos in test and contributing.md ([2ee3ddd](https://github.com/SkeLLLa/node-object-hash/commit/2ee3ddde2cd062844b2d3829f13647bf78b88eb7)) + ### [2.1.2](https://github.com/SkeLLLa/node-object-hash/compare/v2.1.1...v2.1.2) (2021-01-29) ### [2.1.1](https://github.com/SkeLLLa/node-object-hash/compare/v2.1.0...v2.1.1) (2021-01-29) diff --git a/VERSION b/VERSION index 5969682..a4b6ac3 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -v2.1.2 +v2.2.0 diff --git a/docs/README.md b/docs/README.md index ce4bbe5..7e6395a 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,6 @@ -Node object hash - v2.1.1 +Node object hash - v2.1.2 -# Node object hash - v2.1.1 +# Node object hash - v2.1.2 ## Table of contents diff --git a/docs/interfaces/hasher.export_.hashable.md b/docs/interfaces/hasher.export_.hashable.md index 6712889..3719a5a 100644 --- a/docs/interfaces/hasher.export_.hashable.md +++ b/docs/interfaces/hasher.export_.hashable.md @@ -1,4 +1,4 @@ -[Node object hash - v2.1.1](../README.md) / [hasher](../modules/hasher.md) / [export%3D](../modules/hasher.export_.md) / Hashable +[Node object hash - v2.1.2](../README.md) / [hasher](../modules/hasher.md) / [export%3D](../modules/hasher.export_.md) / Hashable # Interface: Hashable @@ -24,4 +24,4 @@ with the function toHash that return the same value will have the same hash • **toHashableString**: () => _string_ -Defined in: [hasher.ts:37](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/hasher.ts#L37) +Defined in: [hasher.ts:37](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/hasher.ts#L37) diff --git a/docs/interfaces/hasher.export_.hasher.md b/docs/interfaces/hasher.export_.hasher.md index f38e443..8e819f9 100644 --- a/docs/interfaces/hasher.export_.hasher.md +++ b/docs/interfaces/hasher.export_.hasher.md @@ -1,4 +1,4 @@ -[Node object hash - v2.1.1](../README.md) / [hasher](../modules/hasher.md) / [export%3D](../modules/hasher.export_.md) / Hasher +[Node object hash - v2.1.2](../README.md) / [hasher](../modules/hasher.md) / [export%3D](../modules/hasher.export_.md) / Hasher # Interface: Hasher @@ -35,7 +35,7 @@ Create hash of an object hash string of an object -Defined in: [hasher.ts:46](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/hasher.ts#L46) +Defined in: [hasher.ts:46](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/hasher.ts#L46) --- @@ -55,7 +55,7 @@ Create sorted string from an object sorted string from an object -Defined in: [hasher.ts:52](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/hasher.ts#L52) +Defined in: [hasher.ts:52](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/hasher.ts#L52) --- @@ -77,4 +77,4 @@ Create sorted string from an object sorted string from an object -Defined in: [hasher.ts:59](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/hasher.ts#L59) +Defined in: [hasher.ts:59](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/hasher.ts#L59) diff --git a/docs/interfaces/hasher.export_.hasheroptions.md b/docs/interfaces/hasher.export_.hasheroptions.md index 5f1bdc3..cb328c0 100644 --- a/docs/interfaces/hasher.export_.hasheroptions.md +++ b/docs/interfaces/hasher.export_.hasheroptions.md @@ -1,4 +1,4 @@ -[Node object hash - v2.1.1](../README.md) / [hasher](../modules/hasher.md) / [export%3D](../modules/hasher.export_.md) / HasherOptions +[Node object hash - v2.1.2](../README.md) / [hasher](../modules/hasher.md) / [export%3D](../modules/hasher.export_.md) / HasherOptions # Interface: HasherOptions @@ -32,7 +32,7 @@ Hash algorithm to use **`default`** 'sha256' -Defined in: [hasher.ts:23](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/hasher.ts#L23) +Defined in: [hasher.ts:23](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/hasher.ts#L23) --- @@ -47,7 +47,7 @@ Advanced coerce options could be provided as object Inherited from: [SorterOptions](objectsorter.export_.sorteroptions.md).[coerce](objectsorter.export_.sorteroptions.md#coerce) -Defined in: [objectSorter.ts:152](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/objectSorter.ts#L152) +Defined in: [objectSorter.ts:167](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/objectSorter.ts#L167) --- @@ -59,7 +59,7 @@ String encoding for hash **`default`** 'base64' -Defined in: [hasher.ts:28](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/hasher.ts#L28) +Defined in: [hasher.ts:28](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/hasher.ts#L28) --- @@ -74,7 +74,7 @@ Advanced sorting options could be provided as object Inherited from: [SorterOptions](objectsorter.export_.sorteroptions.md).[sort](objectsorter.export_.sorteroptions.md#sort) -Defined in: [objectSorter.ts:158](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/objectSorter.ts#L158) +Defined in: [objectSorter.ts:173](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/objectSorter.ts#L173) --- @@ -89,4 +89,4 @@ Advanced sorting options could be provided as object. Inherited from: [SorterOptions](objectsorter.export_.sorteroptions.md).[trim](objectsorter.export_.sorteroptions.md#trim) -Defined in: [objectSorter.ts:164](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/objectSorter.ts#L164) +Defined in: [objectSorter.ts:179](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/objectSorter.ts#L179) diff --git a/docs/interfaces/hasher.hashable.md b/docs/interfaces/hasher.hashable.md index 9dc5973..b99510b 100644 --- a/docs/interfaces/hasher.hashable.md +++ b/docs/interfaces/hasher.hashable.md @@ -1,4 +1,4 @@ -[Node object hash - v2.1.1](../README.md) / [hasher](../modules/hasher.md) / Hashable +[Node object hash - v2.1.2](../README.md) / [hasher](../modules/hasher.md) / Hashable # Interface: Hashable @@ -24,4 +24,4 @@ with the function toHash that return the same value will have the same hash • **toHashableString**: () => _string_ -Defined in: [hasher.ts:37](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/hasher.ts#L37) +Defined in: [hasher.ts:37](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/hasher.ts#L37) diff --git a/docs/interfaces/hasher.hasher-1.md b/docs/interfaces/hasher.hasher-1.md index 8a906a8..280edfb 100644 --- a/docs/interfaces/hasher.hasher-1.md +++ b/docs/interfaces/hasher.hasher-1.md @@ -1,4 +1,4 @@ -[Node object hash - v2.1.1](../README.md) / [hasher](../modules/hasher.md) / Hasher +[Node object hash - v2.1.2](../README.md) / [hasher](../modules/hasher.md) / Hasher # Interface: Hasher @@ -35,7 +35,7 @@ Create hash of an object hash string of an object -Defined in: [hasher.ts:46](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/hasher.ts#L46) +Defined in: [hasher.ts:46](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/hasher.ts#L46) --- @@ -55,7 +55,7 @@ Create sorted string from an object sorted string from an object -Defined in: [hasher.ts:52](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/hasher.ts#L52) +Defined in: [hasher.ts:52](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/hasher.ts#L52) --- @@ -77,4 +77,4 @@ Create sorted string from an object sorted string from an object -Defined in: [hasher.ts:59](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/hasher.ts#L59) +Defined in: [hasher.ts:59](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/hasher.ts#L59) diff --git a/docs/interfaces/hasher.hasheroptions.md b/docs/interfaces/hasher.hasheroptions.md index d9a546a..7b2bba9 100644 --- a/docs/interfaces/hasher.hasheroptions.md +++ b/docs/interfaces/hasher.hasheroptions.md @@ -1,4 +1,4 @@ -[Node object hash - v2.1.1](../README.md) / [hasher](../modules/hasher.md) / HasherOptions +[Node object hash - v2.1.2](../README.md) / [hasher](../modules/hasher.md) / HasherOptions # Interface: HasherOptions @@ -32,7 +32,7 @@ Hash algorithm to use **`default`** 'sha256' -Defined in: [hasher.ts:23](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/hasher.ts#L23) +Defined in: [hasher.ts:23](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/hasher.ts#L23) --- @@ -47,7 +47,7 @@ Advanced coerce options could be provided as object Inherited from: [SorterOptions](objectsorter.export_.sorteroptions.md).[coerce](objectsorter.export_.sorteroptions.md#coerce) -Defined in: [objectSorter.ts:152](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/objectSorter.ts#L152) +Defined in: [objectSorter.ts:167](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/objectSorter.ts#L167) --- @@ -59,7 +59,7 @@ String encoding for hash **`default`** 'base64' -Defined in: [hasher.ts:28](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/hasher.ts#L28) +Defined in: [hasher.ts:28](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/hasher.ts#L28) --- @@ -74,7 +74,7 @@ Advanced sorting options could be provided as object Inherited from: [SorterOptions](objectsorter.export_.sorteroptions.md).[sort](objectsorter.export_.sorteroptions.md#sort) -Defined in: [objectSorter.ts:158](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/objectSorter.ts#L158) +Defined in: [objectSorter.ts:173](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/objectSorter.ts#L173) --- @@ -89,4 +89,4 @@ Advanced sorting options could be provided as object. Inherited from: [SorterOptions](objectsorter.export_.sorteroptions.md).[trim](objectsorter.export_.sorteroptions.md#trim) -Defined in: [objectSorter.ts:164](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/objectSorter.ts#L164) +Defined in: [objectSorter.ts:179](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/objectSorter.ts#L179) diff --git a/docs/interfaces/objectsorter.coerceoptions.md b/docs/interfaces/objectsorter.coerceoptions.md index 9959726..d617475 100644 --- a/docs/interfaces/objectsorter.coerceoptions.md +++ b/docs/interfaces/objectsorter.coerceoptions.md @@ -1,4 +1,4 @@ -[Node object hash - v2.1.1](../README.md) / [objectSorter](../modules/objectsorter.md) / CoerceOptions +[Node object hash - v2.1.2](../README.md) / [objectSorter](../modules/objectsorter.md) / CoerceOptions # Interface: CoerceOptions @@ -14,6 +14,7 @@ Advanced coerce options ### Properties +- [bigint](objectsorter.coerceoptions.md#bigint) - [boolean](objectsorter.coerceoptions.md#boolean) - [date](objectsorter.coerceoptions.md#date) - [function](objectsorter.coerceoptions.md#function) @@ -26,6 +27,26 @@ Advanced coerce options ## Properties +### bigint + +• `Optional` **bigint**: _undefined_ | _boolean_ + +If `true` converts BigInt to string + +**`example`** +// coerce.bigint = true +1n === '1'; + +**`example`** +// coerce.bigint = false +1n !== '1'; + +**`default`** true + +Defined in: [objectSorter.ts:44](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/objectSorter.ts#L44) + +--- + ### boolean • `Optional` **boolean**: _undefined_ | _boolean_ @@ -44,7 +65,7 @@ false !== '0' **`default`** true -Defined in: [objectSorter.ts:22](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/objectSorter.ts#L22) +Defined in: [objectSorter.ts:22](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/objectSorter.ts#L22) --- @@ -62,7 +83,7 @@ If `true` dates may equal the same formatted strings **`default`** true -Defined in: [objectSorter.ts:95](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/objectSorter.ts#L95) +Defined in: [objectSorter.ts:106](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/objectSorter.ts#L106) --- @@ -80,7 +101,7 @@ If `true` functions may equal the same formatted strings **`default`** true -Defined in: [objectSorter.ts:86](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/objectSorter.ts#L86) +Defined in: [objectSorter.ts:97](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/objectSorter.ts#L97) --- @@ -100,7 +121,7 @@ null !== '' **`default`** true -Defined in: [objectSorter.ts:66](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/objectSorter.ts#L66) +Defined in: [objectSorter.ts:77](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/objectSorter.ts#L77) --- @@ -115,12 +136,12 @@ If `true` converts numbers to strings 1 === '1'; **`example`** -// coerce.number = true +// coerce.number = false 1 !== '1'; **`default`** true -Defined in: [objectSorter.ts:33](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/objectSorter.ts#L33) +Defined in: [objectSorter.ts:33](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/objectSorter.ts#L33) --- @@ -138,7 +159,7 @@ If `true` set will be coerced to array **`default`** true -Defined in: [objectSorter.ts:104](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/objectSorter.ts#L104) +Defined in: [objectSorter.ts:115](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/objectSorter.ts#L115) --- @@ -158,7 +179,7 @@ If `true` strings and coerced string will be equal to coerced numbers, booleans, **`default`** true -Defined in: [objectSorter.ts:44](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/objectSorter.ts#L44) +Defined in: [objectSorter.ts:55](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/objectSorter.ts#L55) --- @@ -178,7 +199,7 @@ Symbol.for('a') !== Symbol.for('b') **`default`** true -Defined in: [objectSorter.ts:77](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/objectSorter.ts#L77) +Defined in: [objectSorter.ts:88](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/objectSorter.ts#L88) --- @@ -198,4 +219,4 @@ undefined !== '' **`default`** true -Defined in: [objectSorter.ts:55](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/objectSorter.ts#L55) +Defined in: [objectSorter.ts:66](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/objectSorter.ts#L66) diff --git a/docs/interfaces/objectsorter.export_.coerceoptions.md b/docs/interfaces/objectsorter.export_.coerceoptions.md index 4ec3591..e40c3bb 100644 --- a/docs/interfaces/objectsorter.export_.coerceoptions.md +++ b/docs/interfaces/objectsorter.export_.coerceoptions.md @@ -1,4 +1,4 @@ -[Node object hash - v2.1.1](../README.md) / [objectSorter](../modules/objectsorter.md) / [export%3D](../modules/objectsorter.export_.md) / CoerceOptions +[Node object hash - v2.1.2](../README.md) / [objectSorter](../modules/objectsorter.md) / [export%3D](../modules/objectsorter.export_.md) / CoerceOptions # Interface: CoerceOptions @@ -14,6 +14,7 @@ Advanced coerce options ### Properties +- [bigint](objectsorter.export_.coerceoptions.md#bigint) - [boolean](objectsorter.export_.coerceoptions.md#boolean) - [date](objectsorter.export_.coerceoptions.md#date) - [function](objectsorter.export_.coerceoptions.md#function) @@ -26,6 +27,26 @@ Advanced coerce options ## Properties +### bigint + +• `Optional` **bigint**: _undefined_ | _boolean_ + +If `true` converts BigInt to string + +**`example`** +// coerce.bigint = true +1n === '1'; + +**`example`** +// coerce.bigint = false +1n !== '1'; + +**`default`** true + +Defined in: [objectSorter.ts:44](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/objectSorter.ts#L44) + +--- + ### boolean • `Optional` **boolean**: _undefined_ | _boolean_ @@ -44,7 +65,7 @@ false !== '0' **`default`** true -Defined in: [objectSorter.ts:22](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/objectSorter.ts#L22) +Defined in: [objectSorter.ts:22](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/objectSorter.ts#L22) --- @@ -62,7 +83,7 @@ If `true` dates may equal the same formatted strings **`default`** true -Defined in: [objectSorter.ts:95](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/objectSorter.ts#L95) +Defined in: [objectSorter.ts:106](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/objectSorter.ts#L106) --- @@ -80,7 +101,7 @@ If `true` functions may equal the same formatted strings **`default`** true -Defined in: [objectSorter.ts:86](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/objectSorter.ts#L86) +Defined in: [objectSorter.ts:97](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/objectSorter.ts#L97) --- @@ -100,7 +121,7 @@ null !== '' **`default`** true -Defined in: [objectSorter.ts:66](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/objectSorter.ts#L66) +Defined in: [objectSorter.ts:77](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/objectSorter.ts#L77) --- @@ -115,12 +136,12 @@ If `true` converts numbers to strings 1 === '1'; **`example`** -// coerce.number = true +// coerce.number = false 1 !== '1'; **`default`** true -Defined in: [objectSorter.ts:33](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/objectSorter.ts#L33) +Defined in: [objectSorter.ts:33](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/objectSorter.ts#L33) --- @@ -138,7 +159,7 @@ If `true` set will be coerced to array **`default`** true -Defined in: [objectSorter.ts:104](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/objectSorter.ts#L104) +Defined in: [objectSorter.ts:115](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/objectSorter.ts#L115) --- @@ -158,7 +179,7 @@ If `true` strings and coerced string will be equal to coerced numbers, booleans, **`default`** true -Defined in: [objectSorter.ts:44](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/objectSorter.ts#L44) +Defined in: [objectSorter.ts:55](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/objectSorter.ts#L55) --- @@ -178,7 +199,7 @@ Symbol.for('a') !== Symbol.for('b') **`default`** true -Defined in: [objectSorter.ts:77](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/objectSorter.ts#L77) +Defined in: [objectSorter.ts:88](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/objectSorter.ts#L88) --- @@ -198,4 +219,4 @@ undefined !== '' **`default`** true -Defined in: [objectSorter.ts:55](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/objectSorter.ts#L55) +Defined in: [objectSorter.ts:66](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/objectSorter.ts#L66) diff --git a/docs/interfaces/objectsorter.export_.sorteroptions.md b/docs/interfaces/objectsorter.export_.sorteroptions.md index 2c6ecbd..1b87547 100644 --- a/docs/interfaces/objectsorter.export_.sorteroptions.md +++ b/docs/interfaces/objectsorter.export_.sorteroptions.md @@ -1,4 +1,4 @@ -[Node object hash - v2.1.1](../README.md) / [objectSorter](../modules/objectsorter.md) / [export%3D](../modules/objectsorter.export_.md) / SorterOptions +[Node object hash - v2.1.2](../README.md) / [objectSorter](../modules/objectsorter.md) / [export%3D](../modules/objectsorter.export_.md) / SorterOptions # Interface: SorterOptions @@ -33,7 +33,7 @@ Advanced coerce options could be provided as object **`default`** true -Defined in: [objectSorter.ts:152](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/objectSorter.ts#L152) +Defined in: [objectSorter.ts:167](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/objectSorter.ts#L167) --- @@ -46,7 +46,7 @@ Advanced sorting options could be provided as object **`default`** true -Defined in: [objectSorter.ts:158](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/objectSorter.ts#L158) +Defined in: [objectSorter.ts:173](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/objectSorter.ts#L173) --- @@ -59,4 +59,4 @@ Advanced sorting options could be provided as object. **`default`** false -Defined in: [objectSorter.ts:164](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/objectSorter.ts#L164) +Defined in: [objectSorter.ts:179](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/objectSorter.ts#L179) diff --git a/docs/interfaces/objectsorter.export_.sortoptions.md b/docs/interfaces/objectsorter.export_.sortoptions.md index 6484d94..28ab003 100644 --- a/docs/interfaces/objectsorter.export_.sortoptions.md +++ b/docs/interfaces/objectsorter.export_.sortoptions.md @@ -1,4 +1,4 @@ -[Node object hash - v2.1.1](../README.md) / [objectSorter](../modules/objectsorter.md) / [export%3D](../modules/objectsorter.export_.md) / SortOptions +[Node object hash - v2.1.2](../README.md) / [objectSorter](../modules/objectsorter.md) / [export%3D](../modules/objectsorter.export_.md) / SortOptions # Interface: SortOptions @@ -15,6 +15,7 @@ Advanced sort options ### Properties - [array](objectsorter.export_.sortoptions.md#array) +- [bigint](objectsorter.export_.sortoptions.md#bigint) - [map](objectsorter.export_.sortoptions.md#map) - [object](objectsorter.export_.sortoptions.md#object) - [set](objectsorter.export_.sortoptions.md#set) @@ -27,7 +28,17 @@ Advanced sort options If `true` sort array entries before hash -Defined in: [objectSorter.ts:114](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/objectSorter.ts#L114) +Defined in: [objectSorter.ts:125](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/objectSorter.ts#L125) + +--- + +### bigint + +• `Optional` **bigint**: _undefined_ | _boolean_ + +If `true` sort BigInt entries before hash + +Defined in: [objectSorter.ts:141](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/objectSorter.ts#L141) --- @@ -37,7 +48,7 @@ Defined in: [objectSorter.ts:114](https://github.com/SkeLLLa/node-object-hash/bl If `true` sort map entries before hash -Defined in: [objectSorter.ts:126](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/objectSorter.ts#L126) +Defined in: [objectSorter.ts:137](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/objectSorter.ts#L137) --- @@ -47,7 +58,7 @@ Defined in: [objectSorter.ts:126](https://github.com/SkeLLLa/node-object-hash/bl If `true` sort object entries before hash -Defined in: [objectSorter.ts:118](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/objectSorter.ts#L118) +Defined in: [objectSorter.ts:129](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/objectSorter.ts#L129) --- @@ -57,4 +68,4 @@ Defined in: [objectSorter.ts:118](https://github.com/SkeLLLa/node-object-hash/bl If `true` sort set entries before hash -Defined in: [objectSorter.ts:122](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/objectSorter.ts#L122) +Defined in: [objectSorter.ts:133](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/objectSorter.ts#L133) diff --git a/docs/interfaces/objectsorter.export_.trimoptions.md b/docs/interfaces/objectsorter.export_.trimoptions.md index 1ac8d1d..680f8fc 100644 --- a/docs/interfaces/objectsorter.export_.trimoptions.md +++ b/docs/interfaces/objectsorter.export_.trimoptions.md @@ -1,4 +1,4 @@ -[Node object hash - v2.1.1](../README.md) / [objectSorter](../modules/objectsorter.md) / [export%3D](../modules/objectsorter.export_.md) / TrimOptions +[Node object hash - v2.1.2](../README.md) / [objectSorter](../modules/objectsorter.md) / [export%3D](../modules/objectsorter.export_.md) / TrimOptions # Interface: TrimOptions @@ -25,7 +25,7 @@ Advanced trim options If `true` replaces multiple space with one and trims whitespaces in function body -Defined in: [objectSorter.ts:140](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/objectSorter.ts#L140) +Defined in: [objectSorter.ts:155](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/objectSorter.ts#L155) --- @@ -35,4 +35,4 @@ Defined in: [objectSorter.ts:140](https://github.com/SkeLLLa/node-object-hash/bl If `true` replaces multiple space with one and trims whitespaces in strings -Defined in: [objectSorter.ts:136](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/objectSorter.ts#L136) +Defined in: [objectSorter.ts:151](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/objectSorter.ts#L151) diff --git a/docs/interfaces/objectsorter.sorteroptions.md b/docs/interfaces/objectsorter.sorteroptions.md index 07ee1a3..e0b2158 100644 --- a/docs/interfaces/objectsorter.sorteroptions.md +++ b/docs/interfaces/objectsorter.sorteroptions.md @@ -1,4 +1,4 @@ -[Node object hash - v2.1.1](../README.md) / [objectSorter](../modules/objectsorter.md) / SorterOptions +[Node object hash - v2.1.2](../README.md) / [objectSorter](../modules/objectsorter.md) / SorterOptions # Interface: SorterOptions @@ -29,7 +29,7 @@ Advanced coerce options could be provided as object **`default`** true -Defined in: [objectSorter.ts:152](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/objectSorter.ts#L152) +Defined in: [objectSorter.ts:167](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/objectSorter.ts#L167) --- @@ -42,7 +42,7 @@ Advanced sorting options could be provided as object **`default`** true -Defined in: [objectSorter.ts:158](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/objectSorter.ts#L158) +Defined in: [objectSorter.ts:173](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/objectSorter.ts#L173) --- @@ -55,4 +55,4 @@ Advanced sorting options could be provided as object. **`default`** false -Defined in: [objectSorter.ts:164](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/objectSorter.ts#L164) +Defined in: [objectSorter.ts:179](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/objectSorter.ts#L179) diff --git a/docs/interfaces/objectsorter.sortoptions.md b/docs/interfaces/objectsorter.sortoptions.md index 5723d98..0ea301f 100644 --- a/docs/interfaces/objectsorter.sortoptions.md +++ b/docs/interfaces/objectsorter.sortoptions.md @@ -1,4 +1,4 @@ -[Node object hash - v2.1.1](../README.md) / [objectSorter](../modules/objectsorter.md) / SortOptions +[Node object hash - v2.1.2](../README.md) / [objectSorter](../modules/objectsorter.md) / SortOptions # Interface: SortOptions @@ -15,6 +15,7 @@ Advanced sort options ### Properties - [array](objectsorter.sortoptions.md#array) +- [bigint](objectsorter.sortoptions.md#bigint) - [map](objectsorter.sortoptions.md#map) - [object](objectsorter.sortoptions.md#object) - [set](objectsorter.sortoptions.md#set) @@ -27,7 +28,17 @@ Advanced sort options If `true` sort array entries before hash -Defined in: [objectSorter.ts:114](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/objectSorter.ts#L114) +Defined in: [objectSorter.ts:125](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/objectSorter.ts#L125) + +--- + +### bigint + +• `Optional` **bigint**: _undefined_ | _boolean_ + +If `true` sort BigInt entries before hash + +Defined in: [objectSorter.ts:141](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/objectSorter.ts#L141) --- @@ -37,7 +48,7 @@ Defined in: [objectSorter.ts:114](https://github.com/SkeLLLa/node-object-hash/bl If `true` sort map entries before hash -Defined in: [objectSorter.ts:126](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/objectSorter.ts#L126) +Defined in: [objectSorter.ts:137](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/objectSorter.ts#L137) --- @@ -47,7 +58,7 @@ Defined in: [objectSorter.ts:126](https://github.com/SkeLLLa/node-object-hash/bl If `true` sort object entries before hash -Defined in: [objectSorter.ts:118](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/objectSorter.ts#L118) +Defined in: [objectSorter.ts:129](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/objectSorter.ts#L129) --- @@ -57,4 +68,4 @@ Defined in: [objectSorter.ts:118](https://github.com/SkeLLLa/node-object-hash/bl If `true` sort set entries before hash -Defined in: [objectSorter.ts:122](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/objectSorter.ts#L122) +Defined in: [objectSorter.ts:133](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/objectSorter.ts#L133) diff --git a/docs/interfaces/objectsorter.trimoptions.md b/docs/interfaces/objectsorter.trimoptions.md index 23773e8..56394d8 100644 --- a/docs/interfaces/objectsorter.trimoptions.md +++ b/docs/interfaces/objectsorter.trimoptions.md @@ -1,4 +1,4 @@ -[Node object hash - v2.1.1](../README.md) / [objectSorter](../modules/objectsorter.md) / TrimOptions +[Node object hash - v2.1.2](../README.md) / [objectSorter](../modules/objectsorter.md) / TrimOptions # Interface: TrimOptions @@ -25,7 +25,7 @@ Advanced trim options If `true` replaces multiple space with one and trims whitespaces in function body -Defined in: [objectSorter.ts:140](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/objectSorter.ts#L140) +Defined in: [objectSorter.ts:155](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/objectSorter.ts#L155) --- @@ -35,4 +35,4 @@ Defined in: [objectSorter.ts:140](https://github.com/SkeLLLa/node-object-hash/bl If `true` replaces multiple space with one and trims whitespaces in strings -Defined in: [objectSorter.ts:136](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/objectSorter.ts#L136) +Defined in: [objectSorter.ts:151](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/objectSorter.ts#L151) diff --git a/docs/modules/hasher.export_.md b/docs/modules/hasher.export_.md index 4c87157..7d584ef 100644 --- a/docs/modules/hasher.export_.md +++ b/docs/modules/hasher.export_.md @@ -1,4 +1,4 @@ -[Node object hash - v2.1.1](../README.md) / [hasher](hasher.md) / export%3D +[Node object hash - v2.1.2](../README.md) / [hasher](hasher.md) / export%3D # Namespace: export= diff --git a/docs/modules/hasher.md b/docs/modules/hasher.md index 87cec63..1ede26c 100644 --- a/docs/modules/hasher.md +++ b/docs/modules/hasher.md @@ -1,4 +1,4 @@ -[Node object hash - v2.1.1](../README.md) / hasher +[Node object hash - v2.1.2](../README.md) / hasher # Module: hasher @@ -36,4 +36,4 @@ Hasher constructor hasher instance -Defined in: [hasher.ts:68](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/hasher.ts#L68) +Defined in: [hasher.ts:68](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/hasher.ts#L68) diff --git a/docs/modules/objectsorter.export_.md b/docs/modules/objectsorter.export_.md index 35ece5e..763ffed 100644 --- a/docs/modules/objectsorter.export_.md +++ b/docs/modules/objectsorter.export_.md @@ -1,4 +1,4 @@ -[Node object hash - v2.1.1](../README.md) / [objectSorter](objectsorter.md) / export%3D +[Node object hash - v2.1.2](../README.md) / [objectSorter](objectsorter.md) / export%3D # Namespace: export= @@ -23,4 +23,4 @@ Ƭ **StringifyFn**: (`obj`: [_Hashable_](../interfaces/hasher.export_.hashable.md) | _any_) => _string_ -Defined in: [objectSorter.ts:167](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/objectSorter.ts#L167) +Defined in: [objectSorter.ts:182](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/objectSorter.ts#L182) diff --git a/docs/modules/objectsorter.md b/docs/modules/objectsorter.md index a9df9cb..b309393 100644 --- a/docs/modules/objectsorter.md +++ b/docs/modules/objectsorter.md @@ -1,4 +1,4 @@ -[Node object hash - v2.1.1](../README.md) / objectSorter +[Node object hash - v2.1.2](../README.md) / objectSorter # Module: objectSorter @@ -29,7 +29,7 @@ Ƭ **StringifyFn**: (`obj`: [_Hashable_](../interfaces/hasher.export_.hashable.md) | _any_) => _string_ -Defined in: [objectSorter.ts:167](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/objectSorter.ts#L167) +Defined in: [objectSorter.ts:182](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/objectSorter.ts#L182) ## Functions @@ -49,4 +49,4 @@ Object sorter consturctor function that transforms object to strings -Defined in: [objectSorter.ts:175](https://github.com/SkeLLLa/node-object-hash/blob/6398ebf/src/objectSorter.ts#L175) +Defined in: [objectSorter.ts:190](https://github.com/SkeLLLa/node-object-hash/blob/ca2f87c/src/objectSorter.ts#L190) diff --git a/package-lock.json b/package-lock.json index 34a3e8e..9b42592 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "node-object-hash", - "version": "2.1.2", + "version": "2.2.0", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index d709a8f..35bd26a 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "node-object-hash", - "version": "2.1.2", + "version": "2.2.0", "description": "Node.js object hash library with properties/arrays sorting to provide constant hashes", "keywords": [ "hash",