Interface Sha256

Hierarchy

Properties

Properties

final: ((rawState: Uint8Array) => Uint8Array)

Type declaration

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

      Returns the final hash.

      Parameters

      • rawState: Uint8Array

        a raw state returned by update.

      Returns Uint8Array

hash: ((input: Uint8Array) => Uint8Array)

Type declaration

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

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

      Parameters

      • input: Uint8Array

        a Uint8Array to be hashed using sha256

      Returns Uint8Array

init: (() => Uint8Array)

Type declaration

    • (): Uint8Array
    • Begin an incremental sha256 hashing computation.

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

      Example

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

      Returns Uint8Array

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

Type declaration

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

      Returns a raw state which 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 sha256 computation

      Returns Uint8Array

Generated using TypeDoc