chore(release): 2.2.0

SkeLLLa · Feb 22, 2021 · 056435d · 056435d
1 parent ca2f87c
commit 056435d
Show file tree

Hide file tree

Showing 23 changed files with 161 additions and 83 deletions.
diff --git 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
@@ -1 +1 @@
-v2.1.2
+v2.2.0
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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)