@xyo-network/hash 5.3.24 → 5.3.26

package/README.md

@@ -1,23 +1,1516 @@
+[![logo][]](https://xyo.network)
+
 # @xyo-network/hash
 
-[![logo][]](https://xyo.network)
+[![npm][npm-badge]][npm-link]
+[![license][license-badge]][license-link]
+
+> Primary SDK for using XYO Protocol 2.0
+
+## Install
+
+Using npm:
+
+```sh
+npm install {{name}}
+```
+
+Using yarn:
 
-Version: 5.0.2
+```sh
+yarn add {{name}}
+```
 
-Primary SDK for using XYO Protocol 2.0
+Using pnpm:
 
-## Documentation
+```sh
+pnpm add {{name}}
+```
 
-[TypeDoc Generated Documentation](https://gitbook.xyo.network/xyo-data-lab/xyo-reference/package-documentation/xyo-network__hash)
+Using bun:
+
+```sh
+bun add {{name}}
+```
 
-Part of [sdk-xyo-client-js](https://www.npmjs.com/package/@xyo-network/sdk-xyo-client-js)
 
 ## License
 
-> See the [LICENSE](LICENSE) file for license details
+See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
+
+## Reference
+
+### packages
+
+  ### protocol
+
+    ### packages
+
+      ### core
+
+        ### packages
+
+          ### hash
+
+            ### .temp-typedoc
+
+              ### index
+
+                ### classes
+
+                  ### <a id="ObjectHasher"></a>ObjectHasher
+
+[**@xyo-network/hash**](#../../README)
+
+***
+
+## Extends
+
+- `ObjectHasher`\<`T`\>
+
+## Type Parameters
+
+### T
+
+`T` *extends* `EmptyObject` = `EmptyObject`
+
+## Constructors
+
+### Constructor
+
+```ts
+new ObjectHasher<T>(obj): NodeObjectHasher<T>;
+```
+
+### Parameters
+
+#### obj
+
+`T`
+
+### Returns
+
+`NodeObjectHasher`\<`T`\>
+
+### Inherited from
+
+```ts
+ObjectHasher<T>.constructor
+```
+
+## Properties
+
+### createNodeWorker
+
+```ts
+readonly static createNodeWorker: (func?) => Worker;
+```
+
+### Parameters
+
+#### func?
+
+() => `unknown`
+
+### Returns
+
+`Worker`
+
+### Overrides
+
+```ts
+ObjectHasher.createNodeWorker
+```
+
+***
+
+### allowHashPooling
+
+```ts
+static allowHashPooling: boolean = true;
+```
+
+### Inherited from
+
+```ts
+ObjectHasher.allowHashPooling
+```
+
+***
+
+### allowSubtle
+
+```ts
+static allowSubtle: boolean = true;
+```
+
+### Inherited from
+
+```ts
+ObjectHasher.allowSubtle
+```
+
+***
+
+### createBrowserWorker?
+
+```ts
+static optional createBrowserWorker?: (url?) => Worker | undefined;
+```
+
+### Parameters
+
+#### url?
+
+`URL`
+
+### Returns
+
+`Worker` \| `undefined`
+
+### Inherited from
+
+```ts
+ObjectHasher.createBrowserWorker
+```
+
+***
+
+### subtleHashWorkerUrl?
+
+```ts
+readonly static optional subtleHashWorkerUrl?: URL;
+```
+
+### Inherited from
+
+```ts
+ObjectHasher.subtleHashWorkerUrl
+```
+
+***
+
+### warnIfUsingJsHash
+
+```ts
+static warnIfUsingJsHash: boolean = true;
+```
+
+### Inherited from
+
+```ts
+ObjectHasher.warnIfUsingJsHash
+```
+
+***
+
+### wasmHashWorkerUrl?
+
+```ts
+readonly static optional wasmHashWorkerUrl?: URL;
+```
+
+### Inherited from
+
+```ts
+ObjectHasher.wasmHashWorkerUrl
+```
+
+***
+
+### wasmInitialized
+
+```ts
+readonly static wasmInitialized: Promise<void>;
+```
+
+### Inherited from
+
+```ts
+ObjectHasher.wasmInitialized
+```
+
+***
+
+### wasmSupport
+
+```ts
+readonly static wasmSupport: WasmSupport = wasmSupportStatic;
+```
+
+### Inherited from
+
+```ts
+ObjectHasher.wasmSupport
+```
+
+## Methods
+
+### createWorker()
+
+```ts
+static createWorker(url?, func?): Worker;
+```
+
+### Parameters
+
+#### url?
+
+`URL`
+
+#### func?
+
+() => `unknown`
+
+### Returns
+
+`Worker`
+
+### Inherited from
+
+```ts
+ObjectHasher.createWorker
+```
+
+***
+
+### filterExcludeByHash()
+
+```ts
+static filterExcludeByHash<T>(objs?, hash): Promise<T[]>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `object`
+
+### Parameters
+
+#### objs?
+
+`T`[] = `[]`
+
+#### hash
+
+`BrandedHash` \| `BrandedHash`[]
+
+### Returns
+
+`Promise`\<`T`[]\>
+
+### Inherited from
+
+```ts
+ObjectHasher.filterExcludeByHash
+```
+
+***
+
+### filterIncludeByHash()
+
+```ts
+static filterIncludeByHash<T>(objs?, hash): Promise<T[]>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `object`
+
+### Parameters
+
+#### objs?
+
+`T`[] = `[]`
+
+#### hash
+
+`BrandedHash` \| `BrandedHash`[]
+
+### Returns
+
+`Promise`\<`T`[]\>
+
+### Inherited from
+
+```ts
+ObjectHasher.filterIncludeByHash
+```
+
+***
+
+### findByHash()
+
+```ts
+static findByHash<T>(objs?, hash): Promise<T | undefined>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `object`
+
+### Parameters
+
+#### objs?
+
+`T`[] = `[]`
+
+#### hash
+
+`BrandedHash`
+
+### Returns
+
+`Promise`\<`T` \| `undefined`\>
+
+### Inherited from
+
+```ts
+ObjectHasher.findByHash
+```
+
+***
+
+### hash()
+
+```ts
+static hash<T>(obj): Promise<BrandedHash>;
+```
+
+Asynchronously hashes a payload
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `object`
+
+### Parameters
+
+#### obj
+
+`T`
+
+A payload
+
+### Returns
+
+`Promise`\<`BrandedHash`\>
+
+The payload hash
+
+### Inherited from
+
+```ts
+ObjectHasher.hash
+```
+
+***
+
+### hashBytes()
+
+```ts
+static hashBytes(bytes): Promise<BrandedHash>;
+```
+
+### Parameters
+
+#### bytes
+
+`ArrayBuffer` \| `Uint8Array`\<`ArrayBufferLike`\>
+
+### Returns
+
+`Promise`\<`BrandedHash`\>
+
+### Inherited from
+
+```ts
+ObjectHasher.hashBytes
+```
+
+***
+
+### hashFields()
+
+```ts
+static hashFields<T>(obj): T;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `object`
+
+### Parameters
+
+#### obj
+
+`T`
+
+### Returns
+
+`T`
+
+### Inherited from
+
+```ts
+ObjectHasher.hashFields
+```
+
+***
+
+### hashPairs()
+
+```ts
+static hashPairs<T>(objs): Promise<[T, BrandedHash][]>;
+```
+
+Creates an array of payload/hash tuples based on the payloads passed in
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `object`
+
+### Parameters
+
+#### objs
+
+`T`[]
+
+Any array of payloads
+
+### Returns
+
+`Promise`\<\[`T`, `BrandedHash`\][]\>
+
+An array of payload/hash tuples
+
+### Inherited from
+
+```ts
+ObjectHasher.hashPairs
+```
+
+***
+
+### hashes()
+
+```ts
+static hashes<T>(objs?): Promise<BrandedHash[] | undefined>;
+```
+
+Creates an array of payload hashes based on the payloads passed in
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `object`
+
+### Parameters
+
+#### objs?
+
+`T`[]
+
+Any array of payloads
+
+### Returns
+
+`Promise`\<`BrandedHash`[] \| `undefined`\>
+
+An array of payload hashes
+
+### Inherited from
+
+```ts
+ObjectHasher.hashes
+```
+
+***
+
+### json()
+
+```ts
+static json<T>(payload, meta?): T;
+```
+
+Returns a clone of the payload that is JSON safe
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `object`
+
+### Parameters
+
+#### payload
+
+`T`
+
+#### meta?
+
+`boolean` = `false`
+
+Keeps underscore (meta) fields if set to true
+
+### Returns
+
+`T`
+
+Returns a clone of the payload that is JSON safe
+
+### Inherited from
+
+```ts
+ObjectHasher.json
+```
+
+***
+
+### ~~jsonPayload()~~
+
+```ts
+static jsonPayload<T>(payload, meta?): T;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `object`
+
+### Parameters
+
+#### payload
+
+`T`
+
+#### meta?
+
+`boolean` = `false`
+
+### Returns
+
+`T`
+
+### Deprecated
+
+us json instead
+
+### Inherited from
+
+```ts
+ObjectHasher.jsonPayload
+```
+
+***
+
+### stringifyHashFields()
+
+```ts
+static stringifyHashFields<T>(obj): string;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `object`
+
+### Parameters
+
+#### obj
+
+`T`
+
+### Returns
+
+`string`
+
+### Inherited from
+
+```ts
+ObjectHasher.stringifyHashFields
+```
+
+***
+
+### subtleHash()
+
+```ts
+static subtleHash(data): Promise<ArrayBuffer>;
+```
+
+### Parameters
+
+#### data
+
+`Uint8Array`\<`ArrayBuffer`\>
+
+### Returns
+
+`Promise`\<`ArrayBuffer`\>
+
+### Inherited from
+
+```ts
+ObjectHasher.subtleHash
+```
+
+***
+
+### wasmHash()
+
+```ts
+static wasmHash(data): Promise<BrandedHash>;
+```
+
+### Parameters
+
+#### data
+
+`Uint8Array`
+
+### Returns
+
+`Promise`\<`BrandedHash`\>
+
+### Inherited from
+
+```ts
+ObjectHasher.wasmHash
+```
+
+***
+
+### hash()
+
+```ts
+hash(): Promise<BrandedHash>;
+```
+
+### Returns
+
+`Promise`\<`BrandedHash`\>
+
+### Inherited from
+
+```ts
+ObjectHasher.hash
+```
+
+***
+
+### json()
+
+```ts
+json(meta?): T;
+```
+
+Returns a clone of the payload that is JSON safe
+
+### Parameters
+
+#### meta?
+
+`boolean` = `false`
+
+Keeps underscore (meta) fields if set to true
+
+### Returns
+
+`T`
+
+Returns a clone of the payload that is JSON safe
+
+### Inherited from
+
+```ts
+ObjectHasher.json
+```
+
+                ### functions
+
+                  ### <a id="hasEmptyFields"></a>hasEmptyFields
+
+[**@xyo-network/hash**](#../../README)
+
+***
+
+```ts
+function hasEmptyFields<T>(obj): boolean;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* `object`
+
+## Parameters
+
+### obj
+
+`T`
+
+## Returns
+
+`boolean`
+
+              ### index-browser
+
+                ### classes
+
+                  ### <a id="ObjectHasher"></a>ObjectHasher
+
+[**@xyo-network/hash**](#../../README)
+
+***
+
+## Extends
+
+- `ObjectHasher`\<`T`\>
+
+## Type Parameters
+
+### T
+
+`T` *extends* `EmptyObject` = `EmptyObject`
+
+## Constructors
+
+### Constructor
+
+```ts
+new ObjectHasher<T>(obj): BrowserObjectHasher<T>;
+```
+
+### Parameters
+
+#### obj
+
+`T`
+
+### Returns
+
+`BrowserObjectHasher`\<`T`\>
+
+### Inherited from
+
+```ts
+ObjectHasher<T>.constructor
+```
+
+## Properties
+
+### createBrowserWorker
+
+```ts
+readonly static createBrowserWorker: (url?) => Worker;
+```
+
+### Parameters
+
+#### url?
+
+`URL`
+
+### Returns
+
+`Worker`
+
+### Overrides
+
+```ts
+ObjectHasher.createBrowserWorker
+```
+
+***
+
+### createNodeWorker
+
+```ts
+readonly static createNodeWorker: (func?) => Worker;
+```
+
+### Parameters
+
+#### func?
+
+() => `unknown`
+
+### Returns
+
+`Worker`
+
+### Overrides
+
+```ts
+ObjectHasher.createNodeWorker
+```
+
+***
+
+### subtleHashWorkerUrl
+
+```ts
+readonly static subtleHashWorkerUrl: URL | undefined;
+```
+
+### Overrides
+
+```ts
+ObjectHasher.subtleHashWorkerUrl
+```
+
+***
+
+### wasmHashWorkerUrl
+
+```ts
+readonly static wasmHashWorkerUrl: URL | undefined;
+```
+
+### Overrides
+
+```ts
+ObjectHasher.wasmHashWorkerUrl
+```
+
+***
+
+### allowHashPooling
+
+```ts
+static allowHashPooling: boolean = true;
+```
+
+### Inherited from
+
+```ts
+ObjectHasher.allowHashPooling
+```
+
+***
+
+### allowSubtle
+
+```ts
+static allowSubtle: boolean = true;
+```
+
+### Inherited from
+
+```ts
+ObjectHasher.allowSubtle
+```
+
+***
+
+### warnIfUsingJsHash
+
+```ts
+static warnIfUsingJsHash: boolean = true;
+```
+
+### Inherited from
+
+```ts
+ObjectHasher.warnIfUsingJsHash
+```
+
+***
+
+### wasmInitialized
+
+```ts
+readonly static wasmInitialized: Promise<void>;
+```
+
+### Inherited from
+
+```ts
+ObjectHasher.wasmInitialized
+```
+
+***
+
+### wasmSupport
+
+```ts
+readonly static wasmSupport: WasmSupport = wasmSupportStatic;
+```
+
+### Inherited from
+
+```ts
+ObjectHasher.wasmSupport
+```
+
+## Methods
+
+### createWorker()
+
+```ts
+static createWorker(url?, func?): Worker;
+```
+
+### Parameters
+
+#### url?
+
+`URL`
+
+#### func?
+
+() => `unknown`
+
+### Returns
+
+`Worker`
+
+### Inherited from
+
+```ts
+ObjectHasher.createWorker
+```
+
+***
+
+### filterExcludeByHash()
+
+```ts
+static filterExcludeByHash<T>(objs?, hash): Promise<T[]>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `object`
+
+### Parameters
+
+#### objs?
+
+`T`[] = `[]`
+
+#### hash
+
+`BrandedHash` \| `BrandedHash`[]
+
+### Returns
+
+`Promise`\<`T`[]\>
+
+### Inherited from
+
+```ts
+ObjectHasher.filterExcludeByHash
+```
+
+***
+
+### filterIncludeByHash()
+
+```ts
+static filterIncludeByHash<T>(objs?, hash): Promise<T[]>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `object`
+
+### Parameters
+
+#### objs?
+
+`T`[] = `[]`
+
+#### hash
+
+`BrandedHash` \| `BrandedHash`[]
+
+### Returns
+
+`Promise`\<`T`[]\>
+
+### Inherited from
+
+```ts
+ObjectHasher.filterIncludeByHash
+```
+
+***
+
+### findByHash()
+
+```ts
+static findByHash<T>(objs?, hash): Promise<T | undefined>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `object`
+
+### Parameters
+
+#### objs?
+
+`T`[] = `[]`
+
+#### hash
+
+`BrandedHash`
+
+### Returns
+
+`Promise`\<`T` \| `undefined`\>
+
+### Inherited from
+
+```ts
+ObjectHasher.findByHash
+```
+
+***
+
+### hash()
+
+```ts
+static hash<T>(obj): Promise<BrandedHash>;
+```
+
+Asynchronously hashes a payload
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `object`
+
+### Parameters
+
+#### obj
+
+`T`
+
+A payload
+
+### Returns
+
+`Promise`\<`BrandedHash`\>
+
+The payload hash
+
+### Inherited from
+
+```ts
+ObjectHasher.hash
+```
+
+***
+
+### hashBytes()
+
+```ts
+static hashBytes(bytes): Promise<BrandedHash>;
+```
+
+### Parameters
+
+#### bytes
+
+`ArrayBuffer` \| `Uint8Array`\<`ArrayBufferLike`\>
+
+### Returns
+
+`Promise`\<`BrandedHash`\>
+
+### Inherited from
+
+```ts
+ObjectHasher.hashBytes
+```
+
+***
+
+### hashFields()
+
+```ts
+static hashFields<T>(obj): T;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `object`
+
+### Parameters
+
+#### obj
+
+`T`
+
+### Returns
+
+`T`
+
+### Inherited from
+
+```ts
+ObjectHasher.hashFields
+```
+
+***
+
+### hashPairs()
+
+```ts
+static hashPairs<T>(objs): Promise<[T, BrandedHash][]>;
+```
+
+Creates an array of payload/hash tuples based on the payloads passed in
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `object`
+
+### Parameters
+
+#### objs
+
+`T`[]
+
+Any array of payloads
+
+### Returns
+
+`Promise`\<\[`T`, `BrandedHash`\][]\>
+
+An array of payload/hash tuples
+
+### Inherited from
+
+```ts
+ObjectHasher.hashPairs
+```
+
+***
+
+### hashes()
+
+```ts
+static hashes<T>(objs?): Promise<BrandedHash[] | undefined>;
+```
+
+Creates an array of payload hashes based on the payloads passed in
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `object`
+
+### Parameters
+
+#### objs?
+
+`T`[]
+
+Any array of payloads
+
+### Returns
+
+`Promise`\<`BrandedHash`[] \| `undefined`\>
+
+An array of payload hashes
+
+### Inherited from
+
+```ts
+ObjectHasher.hashes
+```
+
+***
+
+### json()
+
+```ts
+static json<T>(payload, meta?): T;
+```
+
+Returns a clone of the payload that is JSON safe
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `object`
+
+### Parameters
+
+#### payload
+
+`T`
+
+#### meta?
+
+`boolean` = `false`
+
+Keeps underscore (meta) fields if set to true
+
+### Returns
+
+`T`
+
+Returns a clone of the payload that is JSON safe
+
+### Inherited from
+
+```ts
+ObjectHasher.json
+```
+
+***
+
+### ~~jsonPayload()~~
+
+```ts
+static jsonPayload<T>(payload, meta?): T;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `object`
+
+### Parameters
+
+#### payload
+
+`T`
+
+#### meta?
+
+`boolean` = `false`
+
+### Returns
+
+`T`
+
+### Deprecated
+
+us json instead
+
+### Inherited from
+
+```ts
+ObjectHasher.jsonPayload
+```
+
+***
+
+### stringifyHashFields()
+
+```ts
+static stringifyHashFields<T>(obj): string;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `object`
+
+### Parameters
+
+#### obj
+
+`T`
+
+### Returns
+
+`string`
+
+### Inherited from
+
+```ts
+ObjectHasher.stringifyHashFields
+```
+
+***
+
+### subtleHash()
+
+```ts
+static subtleHash(data): Promise<ArrayBuffer>;
+```
+
+### Parameters
+
+#### data
+
+`Uint8Array`\<`ArrayBuffer`\>
+
+### Returns
+
+`Promise`\<`ArrayBuffer`\>
+
+### Inherited from
+
+```ts
+ObjectHasher.subtleHash
+```
+
+***
+
+### wasmHash()
+
+```ts
+static wasmHash(data): Promise<BrandedHash>;
+```
+
+### Parameters
+
+#### data
+
+`Uint8Array`
+
+### Returns
+
+`Promise`\<`BrandedHash`\>
+
+### Inherited from
+
+```ts
+ObjectHasher.wasmHash
+```
+
+***
+
+### hash()
+
+```ts
+hash(): Promise<BrandedHash>;
+```
+
+### Returns
+
+`Promise`\<`BrandedHash`\>
+
+### Inherited from
+
+```ts
+ObjectHasher.hash
+```
+
+***
+
+### json()
+
+```ts
+json(meta?): T;
+```
+
+Returns a clone of the payload that is JSON safe
+
+### Parameters
+
+#### meta?
+
+`boolean` = `false`
+
+Keeps underscore (meta) fields if set to true
+
+### Returns
+
+`T`
+
+Returns a clone of the payload that is JSON safe
+
+### Inherited from
+
+```ts
+ObjectHasher.json
+```
+
+                ### functions
+
+                  ### <a id="removeEmptyFields"></a>removeEmptyFields
+
+[**@xyo-network/hash**](#../../README)
+
+***
+
+```ts
+function removeEmptyFields<T>(obj): T;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* `object`
+
+## Parameters
+
+### obj
+
+`T`
+
+## Returns
+
+`T`
+
+                  ### <a id="sortFields"></a>sortFields
+
+[**@xyo-network/hash**](#../../README)
+
+***
+
+```ts
+function sortFields<T>(obj): T;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* `object`
+
+## Parameters
+
+### obj
+
+`T`
+
+## Returns
 
-## Credits
+`T`
 
-[Made with 🔥 and ❄️ by XYO](https://xyo.network)
 
-[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
+[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
+[npm-badge]: https://img.shields.io/npm/v/@xyo-network/hash.svg
+[npm-link]: https://www.npmjs.com/package/@xyo-network/hash
+[license-badge]: https://img.shields.io/npm/l/@xyo-network/hash.svg
+[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE