Interface UseHashResult

Return type of the useHash hook.

Example

const { hash, digest, isHashing }: UseHashResult = useHash();

interface UseHashResult {
    hash: (
        data: string | Uint8Array<ArrayBufferLike>,
        algorithm?:
            | "sha256"
            | "sha384"
            | "sha512"
            | "sha3-256"
            | "sha3-512"
            | "blake2b"
            | "blake3",
    ) => string;
    digest: string
    | null;
    isHashing: boolean;
}

Index

Properties

hash digest isHashing

Properties

hash

hash: (
    data: string | Uint8Array<ArrayBufferLike>,
    algorithm?:
        | "sha256"
        | "sha384"
        | "sha512"
        | "sha3-256"
        | "sha3-512"
        | "blake2b"
        | "blake3",
) => string

Compute a cryptographic hash digest. Returns the hex-encoded digest.

digest

digest: string | null

The last computed hex-encoded digest.

isHashing

isHashing: boolean

True while a hash is being computed.

Interface UseHashResult

Example

Index

Properties

Properties

hash

digest

isHashing

Settings

On This Page