Class Hasher<Name, Code>

Hasher represents a hashing algorithm implementation that produces as MultihashDigest.

Type Parameters

Name extends string
Code extends number

Implements

MultihashHasher<Code>

Index

Constructors

Properties

code encode maxDigestLength? minDigestLength name

Methods

Constructors

constructor

new Hasher<Name extends string, Code extends number>(
    name: Name,
    code: Code,
    encode: (input: Uint8Array) => Await<Uint8Array<ArrayBuffer>>,
    minDigestLength?: number,
    maxDigestLength?: number,
): Hasher<Name, Code>
Type Parameters
- Name extends string
- Code extends number
Parameters
- name: Name
- code: Code
- encode: (input: Uint8Array) => Await<Uint8Array<ArrayBuffer>>
- OptionalminDigestLength: number
- OptionalmaxDigestLength: number
Returns Hasher<Name, Code>
- Defined in src/hashes/hasher.ts:56

Properties

`Readonly`code

code: Code

Code of the multihash

`Readonly`encode

encode: (input: Uint8Array) => Await<Uint8Array<ArrayBuffer>>

Returns the raw digest representation of the binary input (e.g. without hashing codec)

`Optional` `Readonly`maxDigestLength

maxDigestLength?: number

`Readonly`minDigestLength

minDigestLength: number

`Readonly`name

name: Name

Name of the multihash

Methods

digest

digest(input: Uint8Array, options?: DigestOptions): Await<Digest<Code, number>>
Takes binary input and returns it (multi) hash digest. Return value is either promise of a digest or a digest. This way general use can await while performance critical code may asses return value to decide whether await is needed.
Parameters
- input: Uint8Array
- Optionaloptions: DigestOptions
Returns Await<Digest<Code, number>>
Implementation of MultihashHasher.digest
- Defined in src/hashes/hasher.ts:64