chore(release): 2.3.5

SkeLLLa · Jun 17, 2021 · 7b1d04d · 7b1d04d
1 parent db2f49f
commit 7b1d04d
Show file tree

Hide file tree

Showing 23 changed files with 411 additions and 243 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,18 @@
 
 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.3.5](https://github.com/SkeLLLa/node-object-hash/compare/v2.3.4...v2.3.5) (2021-06-17)
+
+
+### Misc
+
+* **deps:** update ([d16d2b2](https://github.com/SkeLLLa/node-object-hash/commit/d16d2b2ecaa36bdbb3a4c0d238be4dae4bf18222))
+
+
+### Bug fixes
+
+* revert ts to 4.2 ([6423ea7](https://github.com/SkeLLLa/node-object-hash/commit/6423ea701113f92f9570169c63138dde012f20ed))
+
 ### [2.3.4](https://github.com/SkeLLLa/node-object-hash/compare/v2.3.3...v2.3.4) (2021-06-14)
 
 ### [2.3.3](https://github.com/SkeLLLa/node-object-hash/compare/v2.3.2...v2.3.3) (2021-05-29)

diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-v2.3.4
+v2.3.5
diff --git a/docs/README.md b/docs/README.md
@@ -1,6 +1,6 @@
-Node object hash - v2.3.3
+Node object hash - v2.3.4
 
-# Node object hash - v2.3.3
+# Node object hash - v2.3.4
 
 ## 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.3.3](../README.md) / [hasher](../modules/hasher.md) / [export%3D](../modules/hasher.export_.md) / Hashable
+[Node object hash - v2.3.4](../README.md) / [hasher](../modules/hasher.md) / [export%3D](../modules/hasher.export_.md) / Hashable
 
 # Interface: Hashable
 
@@ -8,10 +8,6 @@ If object implements Hashable interface then value from toHash
 will be used for hash function. It means that the different objects
 with the function toHash that return the same value will have the same hash
 
-## Hierarchy
-
-- **Hashable**
-
 ## Table of contents
 
 ### Properties
@@ -22,6 +18,16 @@ with the function toHash that return the same value will have the same hash
 
 ### toHashableString
 
-• **toHashableString**: () => _string_
+• **toHashableString**: () => `string`
+
+#### Type declaration
+
+▸ (): `string`
+
+##### Returns
+
+`string`
+
+#### Defined in
 
-Defined in: [hasher.ts:37](https://github.com/SkeLLLa/node-object-hash/blob/2e623c6/src/hasher.ts#L37)
+[hasher.ts:37](https://github.com/SkeLLLa/node-object-hash/blob/db2f49f/src/hasher.ts#L37)
diff --git a/docs/interfaces/hasher.export_.hasher.md b/docs/interfaces/hasher.export_.hasher.md
@@ -1,13 +1,9 @@
-[Node object hash - v2.3.3](../README.md) / [hasher](../modules/hasher.md) / [export%3D](../modules/hasher.export_.md) / Hasher
+[Node object hash - v2.3.4](../README.md) / [hasher](../modules/hasher.md) / [export%3D](../modules/hasher.export_.md) / Hasher
 
 # Interface: Hasher
 
 [hasher](../modules/hasher.md).[export=](../modules/hasher.export_.md).Hasher
 
-## Hierarchy
-
-- **Hasher**
-
 ## Table of contents
 
 ### Methods
@@ -20,61 +16,73 @@
 
 ### hash
 
-▸ **hash**(`object`: _any_, `opts?`: [_HasherOptions_](hasher.export_.hasheroptions.md)): _string_
+▸ **hash**(`object`, `opts?`): `string`
 
 Create hash of an object
 
-#### Parameters:
+#### Parameters
 
-| Name     | Type                                               | Description   |
-| -------- | -------------------------------------------------- | ------------- |
-| `object` | _any_                                              | source object |
-| `opts?`  | [_HasherOptions_](hasher.export_.hasheroptions.md) | -             |
+| Name     | Type                                             | Description   |
+| :------- | :----------------------------------------------- | :------------ |
+| `object` | `any`                                            | source object |
+| `opts?`  | [HasherOptions](hasher.export_.hasheroptions.md) | -             |
 
-**Returns:** _string_
+#### Returns
+
+`string`
 
 hash string of an object
 
-Defined in: [hasher.ts:46](https://github.com/SkeLLLa/node-object-hash/blob/2e623c6/src/hasher.ts#L46)
+#### Defined in
+
+[hasher.ts:46](https://github.com/SkeLLLa/node-object-hash/blob/db2f49f/src/hasher.ts#L46)
 
 ---
 
 ### sort
 
-▸ **sort**(`object`: _any_): _string_
+▸ **sort**(`object`): `string`
 
 Create sorted string from an object
 
-#### Parameters:
+#### Parameters
 
 | Name     | Type  | Description   |
-| -------- | ----- | ------------- |
-| `object` | _any_ | source object |
+| :------- | :---- | :------------ |
+| `object` | `any` | source object |
 
-**Returns:** _string_
+#### Returns
+
+`string`
 
 sorted string from an object
 
-Defined in: [hasher.ts:52](https://github.com/SkeLLLa/node-object-hash/blob/2e623c6/src/hasher.ts#L52)
+#### Defined in
+
+[hasher.ts:52](https://github.com/SkeLLLa/node-object-hash/blob/db2f49f/src/hasher.ts#L52)
 
 ---
 
 ### sortObject
 
-▸ **sortObject**(`object`: _any_): _string_
+▸ **sortObject**(`object`): `string`
 
 Create sorted string from an object
 
 **`alias`** sort
 
-#### Parameters:
+#### Parameters
 
 | Name     | Type  | Description   |
-| -------- | ----- | ------------- |
-| `object` | _any_ | source object |
+| :------- | :---- | :------------ |
+| `object` | `any` | source object |
 
-**Returns:** _string_
+#### Returns
+
+`string`
 
 sorted string from an object
 
-Defined in: [hasher.ts:59](https://github.com/SkeLLLa/node-object-hash/blob/2e623c6/src/hasher.ts#L59)
+#### Defined in
+
+[hasher.ts:59](https://github.com/SkeLLLa/node-object-hash/blob/db2f49f/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.3.3](../README.md) / [hasher](../modules/hasher.md) / [export%3D](../modules/hasher.export_.md) / HasherOptions
+[Node object hash - v2.3.4](../README.md) / [hasher](../modules/hasher.md) / [export%3D](../modules/hasher.export_.md) / HasherOptions
 
 # Interface: HasherOptions
 
@@ -8,7 +8,7 @@ Object hasher options
 
 ## Hierarchy
 
-- [_SorterOptions_](objectsorter.export_.sorteroptions.md)
+- [SorterOptions](objectsorter.export_.sorteroptions.md)
 
   ↳ **HasherOptions**
 
@@ -26,67 +26,83 @@ Object hasher options
 
 ### alg
 
-• `Optional` **alg**: _undefined_ | _string_
+• `Optional` **alg**: `string`
 
 Hash algorithm to use
 
 **`default`** 'sha256'
 
-Defined in: [hasher.ts:23](https://github.com/SkeLLLa/node-object-hash/blob/2e623c6/src/hasher.ts#L23)
+#### Defined in
+
+[hasher.ts:23](https://github.com/SkeLLLa/node-object-hash/blob/db2f49f/src/hasher.ts#L23)
 
 ---
 
 ### coerce
 
-• `Optional` **coerce**: _undefined_ | _boolean_ | [_CoerceOptions_](objectsorter.export_.coerceoptions.md)
+• `Optional` **coerce**: `boolean` \| [CoerceOptions](objectsorter.export_.coerceoptions.md)
 
 If `true` enables type coercion.
 Advanced coerce options could be provided as object
 
 **`default`** true
 
-Inherited from: [SorterOptions](objectsorter.export_.sorteroptions.md).[coerce](objectsorter.export_.sorteroptions.md#coerce)
+#### Inherited from
+
+[SorterOptions](objectsorter.export_.sorteroptions.md).[coerce](objectsorter.export_.sorteroptions.md#coerce)
 
-Defined in: [objectSorter.ts:171](https://github.com/SkeLLLa/node-object-hash/blob/2e623c6/src/objectSorter.ts#L171)
+#### Defined in
+
+[objectSorter.ts:171](https://github.com/SkeLLLa/node-object-hash/blob/db2f49f/src/objectSorter.ts#L171)
 
 ---
 
 ### enc
 
-• `Optional` **enc**: _undefined_ | _base64_ | _hex_
+• `Optional` **enc**: `BinaryToTextEncoding`
 
 String encoding for hash
 
 **`default`** 'base64'
 
-Defined in: [hasher.ts:28](https://github.com/SkeLLLa/node-object-hash/blob/2e623c6/src/hasher.ts#L28)
+#### Defined in
+
+[hasher.ts:28](https://github.com/SkeLLLa/node-object-hash/blob/db2f49f/src/hasher.ts#L28)
 
 ---
 
 ### sort
 
-• `Optional` **sort**: _undefined_ | _boolean_ | [_SortOptions_](objectsorter.export_.sortoptions.md)
+• `Optional` **sort**: `boolean` \| [SortOptions](objectsorter.export_.sortoptions.md)
 
 If `true` enables sorting.
 Advanced sorting options could be provided as object
 
 **`default`** true
 
-Inherited from: [SorterOptions](objectsorter.export_.sorteroptions.md).[sort](objectsorter.export_.sorteroptions.md#sort)
+#### Inherited from
 
-Defined in: [objectSorter.ts:177](https://github.com/SkeLLLa/node-object-hash/blob/2e623c6/src/objectSorter.ts#L177)
+[SorterOptions](objectsorter.export_.sorteroptions.md).[sort](objectsorter.export_.sorteroptions.md#sort)
+
+#### Defined in
+
+[objectSorter.ts:177](https://github.com/SkeLLLa/node-object-hash/blob/db2f49f/src/objectSorter.ts#L177)
 
 ---
 
 ### trim
 
-• `Optional` **trim**: _undefined_ | _boolean_ | [_TrimOptions_](objectsorter.export_.trimoptions.md)
+• `Optional` **trim**: `boolean` \| [TrimOptions](objectsorter.export_.trimoptions.md)
 
 If `true` enables trimming and multiple whitespace replacement.
 Advanced sorting options could be provided as object.
 
 **`default`** false
 
-Inherited from: [SorterOptions](objectsorter.export_.sorteroptions.md).[trim](objectsorter.export_.sorteroptions.md#trim)
+#### Inherited from
+
+[SorterOptions](objectsorter.export_.sorteroptions.md).[trim](objectsorter.export_.sorteroptions.md#trim)
+
+#### Defined in
 
-Defined in: [objectSorter.ts:183](https://github.com/SkeLLLa/node-object-hash/blob/2e623c6/src/objectSorter.ts#L183)
+[objectSorter.ts:183](https://github.com/SkeLLLa/node-object-hash/blob/db2f49f/src/objectSorter.ts#L183)
diff --git a/docs/interfaces/hasher.hashable.md b/docs/interfaces/hasher.hashable.md
@@ -1,4 +1,4 @@
-[Node object hash - v2.3.3](../README.md) / [hasher](../modules/hasher.md) / Hashable
+[Node object hash - v2.3.4](../README.md) / [hasher](../modules/hasher.md) / Hashable
 
 # Interface: Hashable
 
@@ -8,10 +8,6 @@ If object implements Hashable interface then value from toHash
 will be used for hash function. It means that the different objects
 with the function toHash that return the same value will have the same hash
 
-## Hierarchy
-
-- **Hashable**
-
 ## Table of contents
 
 ### Properties
@@ -22,6 +18,16 @@ with the function toHash that return the same value will have the same hash
 
 ### toHashableString
 
-• **toHashableString**: () => _string_
+• **toHashableString**: () => `string`
+
+#### Type declaration
+
+▸ (): `string`
+
+##### Returns
+
+`string`
+
+#### Defined in
 
-Defined in: [hasher.ts:37](https://github.com/SkeLLLa/node-object-hash/blob/2e623c6/src/hasher.ts#L37)
+[hasher.ts:37](https://github.com/SkeLLLa/node-object-hash/blob/db2f49f/src/hasher.ts#L37)