Class Digest

Static ReadonlyDIGEST_SIZE

data

• data(): Uint8Array

  Get the digest data.

  Returns Uint8Array

StaticfromData

• fromData(data: Uint8Array): Digest

  Create a Digest from a 32-byte array.

  Parameters

  • data: Uint8Array

  Returns Digest

StaticfromDataRef

• fromDataRef(data: Uint8Array): Digest

  Create a Digest from data, validating the length. Alias for fromData for compatibility with Rust API.

  Parameters

  • data: Uint8Array

  Returns Digest

StaticfromHex

• fromHex(hex: string): Digest

  Create a Digest from hex string.

  Parameters

  • hex: string

  Returns Digest

  Throws

  Error if the hex string is not exactly 64 characters.

StaticfromImage

• fromImage(image: Uint8Array): Digest

  Compute SHA-256 digest of data (called "image" in Rust).

  Parameters

  • image: Uint8Array

    The data to hash

  Returns Digest

StaticfromImageParts

• fromImageParts(imageParts: Uint8Array<ArrayBufferLike>[]): Digest

  Compute SHA-256 digest from multiple data parts.

  The parts are concatenated and then hashed.

  Parameters

  • imageParts: Uint8Array<ArrayBufferLike>[]

    Array of byte arrays to concatenate and hash

  Returns Digest

StaticfromDigests

• fromDigests(digests: Digest[]): Digest

  Compute SHA-256 digest from an array of Digests.

  The digest bytes are concatenated and then hashed.

  Parameters

  • digests: Digest[]

    Array of Digests to combine

  Returns Digest

Statichash

• hash(data: Uint8Array): Digest

  Compute SHA-256 digest of data (legacy alias for fromImage).

  Parameters

  • data: Uint8Array

  Returns Digest

  Deprecated

  Use fromImage instead

toData

• toData(): Uint8Array

  Get the raw digest bytes as a copy.

  Returns Uint8Array

asBytes

• asBytes(): Uint8Array

  Get a reference to the raw digest bytes.

  Returns Uint8Array

hex

• hex(): string

  Get hex string representation.

  Returns string

toHex

• toHex(): string

  Get hex string representation (alias for hex()).

  Returns string

toBase64

• toBase64(): string

  Get base64 representation.

  Returns string

shortDescription

• shortDescription(): string

  Get the first four bytes of the digest as a hexadecimal string. Useful for short descriptions.

  Returns string

validate

• validate(image: Uint8Array): boolean

  Validate the digest against the given image.

  The image is hashed with SHA-256 and compared to this digest.

  Parameters

  • image: Uint8Array

  Returns boolean

  true if the digest matches the image.

equals

• equals(other: Digest): boolean

  Compare with another Digest.

  Parameters

  • other: Digest

  Returns boolean

compare

• compare(other: Digest): number

  Compare digests lexicographically.

  Parameters

  • other: Digest

  Returns number

toString

• toString(): string

  Get string representation.

  Returns string

digest

• digest(): Digest

  A Digest is its own digest provider - returns itself.

  Returns Digest

cborTags

• cborTags(): Tag[]

  Returns the CBOR tags associated with Digest.

  Returns Tag[]

untaggedCbor

• untaggedCbor(): Cbor

  Returns the untagged CBOR encoding (as a byte string).

  Returns Cbor

taggedCbor

• taggedCbor(): Cbor

  Returns the tagged CBOR encoding.

  Returns Cbor

taggedCborData

• taggedCborData(): Uint8Array

  Returns the tagged value in CBOR binary representation.

  Returns Uint8Array

fromUntaggedCbor

• fromUntaggedCbor(cbor: Cbor): Digest

  Creates a Digest by decoding it from untagged CBOR.

  Parameters

  • cbor: Cbor

  Returns Digest

fromTaggedCbor

• fromTaggedCbor(cbor: Cbor): Digest

  Creates a Digest by decoding it from tagged CBOR.

  Parameters

  • cbor: Cbor

  Returns Digest

StaticfromTaggedCbor

• fromTaggedCbor(cbor: Cbor): Digest

  Static method to decode from tagged CBOR.

  Parameters

  • cbor: Cbor

  Returns Digest

StaticfromTaggedCborData

• fromTaggedCborData(data: Uint8Array): Digest

  Static method to decode from tagged CBOR binary data.

  Parameters

  • data: Uint8Array

  Returns Digest

StaticfromUntaggedCborData

• fromUntaggedCborData(data: Uint8Array): Digest

  Static method to decode from untagged CBOR binary data.

  Parameters

  • data: Uint8Array

  Returns Digest

ur

• ur(): UR

  Returns the UR representation of the Digest. Note: URs use untagged CBOR since the type is conveyed by the UR type itself.

  Returns UR

urString

• urString(): string

  Returns the UR string representation.

  Returns string

StaticfromUR

• fromUR(ur: UR): Digest

  Creates a Digest from a UR.

  Parameters

  • ur: UR

  Returns Digest

StaticfromURString

• fromURString(urString: string): Digest

  Creates a Digest from a UR string.

  Parameters

  • urString: string

  Returns Digest

StaticvalidateOpt

• validateOpt(image: Uint8Array, digest: Digest | undefined): boolean

  Validate the given data against the digest, if any.

  Returns true if the digest is undefined or if the digest matches the image's digest. Returns false if the digest does not match.

  Parameters

  • image: Uint8Array
  • digest: Digest | undefined

  Returns boolean