Interface SyncMultihashHasher<Code>

Sync variant of MultihashHasher that refines return type of the digest to MultihashDigest. It is subtype of MultihashHasher so implementations of this interface can be passed anywhere MultihashHasher is expected, allowing consumer to either await or check the return type to decide whether to await or proceed with return value.

SyncMultihashHasher is useful in certain APIs where async hashing would be impractical e.g. implementation of Hash Array Mapped Trie (HAMT).

interface SyncMultihashHasher<Code extends number = number> {
    code: Code;
    name: string;
    digest(input: Uint8Array, options?: DigestOptions): MultihashDigest<Code>;
}

Type Parameters

Code extends number = number

Hierarchy (View Summary)

MultihashHasher<Code>
- SyncMultihashHasher

Index

Properties

code name

Methods

digest

Properties

code

code: Code

Code of the multihash

name

name: string

Name of the multihash

Methods

digest

digest(input: Uint8Array, options?: DigestOptions): MultihashDigest<Code>
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 MultihashDigest<Code>
Overrides MultihashHasher.digest
- Defined in src/hashes/interface.ts:71

Interface SyncMultihashHasher<Code>

Type Parameters

Hierarchy (View Summary)

Index

Properties

Methods

Properties

code

name

Methods

digest

Parameters

Returns MultihashDigest<Code>

Settings

On This Page