Type alias Sha512

Sha512: HashFunction & {
    final: ((rawState) => Uint8Array);
    hash: ((input) => Uint8Array);
    init: (() => Uint8Array);
    update: ((rawState, input) => Uint8Array);
}

Type declaration

  • final: ((rawState) => Uint8Array)

    Finish an incremental sha512 hashing computation.

    Returns the final hash.

    Param: rawState

    a raw state returned by update.

      • (rawState): Uint8Array
      • Finish an incremental sha512 hashing computation.

        Returns the final hash.

        Parameters

        • rawState: Uint8Array

          a raw state returned by update.

        Returns Uint8Array

  • hash: ((input) => Uint8Array)

    Returns the sha512 hash of the provided input.

    To incrementally construct a sha512 hash (e.g. for streaming), use init, update, and final.

    Param: input

    a Uint8Array to be hashed using sha512

      • (input): Uint8Array
      • Returns the sha512 hash of the provided input.

        To incrementally construct a sha512 hash (e.g. for streaming), use init, update, and final.

        Parameters

        • input: Uint8Array

          a Uint8Array to be hashed using sha512

        Returns Uint8Array

  • init: (() => Uint8Array)

    Begin an incremental sha512 hashing computation.

    The returned raw state can be provided to update with additional input to advance the computation.

    Example

    const state1 = sha512.init();
    const state2 = sha512.update(state1, new Uint8Array([1, 2, 3]));
    const state3 = sha512.update(state2, new Uint8Array([4, 5, 6]));
    const hash = sha512.final(state3);
      • (): Uint8Array
      • Begin an incremental sha512 hashing computation.

        The returned raw state can be provided to update with additional input to advance the computation.

        Example

        const state1 = sha512.init();
        const state2 = sha512.update(state1, new Uint8Array([1, 2, 3]));
        const state3 = sha512.update(state2, new Uint8Array([4, 5, 6]));
        const hash = sha512.final(state3);

        Returns Uint8Array

  • update: ((rawState, input) => Uint8Array)

    Add input to an incremental sha512 hashing computation.

    Returns a raw state that can again be passed to update with additional input to continue the computation.

    When the computation has been updated with all input, pass the raw state to final to finish and return a hash.

    Param: rawState

    a raw state returned by either init or update

    Param: input

    a Uint8Array to be added to the sha512 computation

      • (rawState, input): Uint8Array
      • Add input to an incremental sha512 hashing computation.

        Returns a raw state that can again be passed to update with additional input to continue the computation.

        When the computation has been updated with all input, pass the raw state to final to finish and return a hash.

        Parameters

        • rawState: Uint8Array

          a raw state returned by either init or update

        • input: Uint8Array

          a Uint8Array to be added to the sha512 computation

        Returns Uint8Array

Generated using TypeDoc