Class PayloadHasher<T>

StaticallowHashPooling

StaticallowSubtle

Static OptionalcreateBrowserWorker

Static ReadonlycreateNodeWorker

Static Readonlyinitialized

Static Optional ReadonlysubtleHashWorkerUrl

StaticwarnIfUsingJsHash

Static Optional ReadonlywasmHashWorkerUrl

Static ReadonlywasmInitialized

Static ReadonlywasmSupport

hash

• hash(): Promise<Lowercase<string>>

  Returns Promise<Lowercase<string>>

json

• json(meta?: boolean): 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

StaticcreateWorker

• createWorker(url?: URL, func?: () => unknown): Worker

  Parameters

  • Optionalurl: URL
  • Optionalfunc: () => unknown

  Returns Worker

StaticfilterExcludeByHash

• filterExcludeByHash<T extends object>(
      objs?: T[],
      hash: Lowercase<string> | Lowercase<string>[],
  ): Promise<T[]>

  Type Parameters

  • T extends object

  Parameters

  • objs: T[] = []
  • hash: Lowercase<string> | Lowercase<string>[]

  Returns Promise<T[]>

StaticfilterIncludeByHash

• filterIncludeByHash<T extends object>(
      objs?: T[],
      hash: Lowercase<string> | Lowercase<string>[],
  ): Promise<T[]>

  Type Parameters

  • T extends object

  Parameters

  • objs: T[] = []
  • hash: Lowercase<string> | Lowercase<string>[]

  Returns Promise<T[]>

StaticfindByHash

• findByHash<T extends object>(
      objs?: T[],
      hash: Lowercase<string>,
  ): Promise<undefined | T>

  Type Parameters

  • T extends object

  Parameters

  • objs: T[] = []
  • hash: Lowercase<string>

  Returns Promise<undefined | T>

Statichash

• hash<T extends object>(obj: T): Promise<Lowercase<string>>

  Asynchronously hashes a payload

  Type Parameters

  • T extends object

  Parameters

  • obj: T

    A payload

  Returns Promise<Lowercase<string>>

  The payload hash

Statichashes

• hashes<T extends object>(objs?: T[]): Promise<undefined | Lowercase<string>[]>

  Creates an array of payload hashes based on the payloads passed in

  Type Parameters

  • T extends object

  Parameters

  • Optionalobjs: T[]

    Any array of payloads

  Returns Promise<undefined | Lowercase<string>[]>

  An array of payload hashes

StatichashFields

• hashFields<T extends object>(obj: T): T

  Type Parameters

  • T extends object

  Parameters

  • obj: T

  Returns T

StatichashPairs

• hashPairs<T extends object>(objs: T[]): Promise<[T, Lowercase<string>][]>

  Creates an array of payload/hash tuples based on the payloads passed in

  Type Parameters

  • T extends object

  Parameters

  • objs: T[]

    Any array of payloads

  Returns Promise<[T, Lowercase<string>][]>

  An array of payload/hash tuples

Staticjson

• json<T extends object>(payload: T, meta?: boolean): T

  Returns a clone of the payload that is JSON safe

  Type Parameters

  • 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

StaticjsonPayload

• jsonPayload<T extends object>(payload: T, meta?: boolean): T

  Type Parameters

  • T extends object

  Parameters

  • payload: T
  • meta: boolean = false

  Returns T

  Deprecated

  us json instead

StaticstringifyHashFields

• stringifyHashFields<T extends object>(obj: T): string

  Type Parameters

  • T extends object

  Parameters

  • obj: T

  Returns string

StaticsubtleHash

• subtleHash(data: Uint8Array): Promise<ArrayBuffer>

  Parameters

  • data: Uint8Array

  Returns Promise<ArrayBuffer>

StaticwasmHash

• wasmHash(data: string): Promise<any>

  Parameters

  • data: string

  Returns Promise<any>