Class Hash

Represents a cryptographic hash. This class provides methods for creating, manipulating, and comparing hash values.

Hierarchy

Hash

Index

Constructors

Properties

hashBytes ByteHashLen StringHashLen

Methods

equals toBytes toHex toJSON createHashArray fromBuffer fromBytes fromHex fromJSON

Constructors

constructor

new Hash(hashBytes: Uint8Array): Hash
Creates a new Hash instance.

Throws
Error if the byte array length does not match the expected hash length.
Parameters
- hashBytes: Uint8Array
  
  The byte array representing the hash.
Returns Hash
- Defined in src/types/key/Hash.ts:23

Properties

`Private` hashBytes

hashBytes: Uint8Array

`Static` ByteHashLen

ByteHashLen: number = 32

The fixed length of the hash in bytes.

`Static` StringHashLen

StringHashLen: number = 64

The fixed length of the hash string representation in hexadecimal characters.

Methods

equals

equals(other: Hash): boolean
Compares this Hash instance with another Hash instance for equality.

Returns
True if the hashes are equal, false otherwise.
Parameters
- other: Hash
  
  The other Hash to compare with.
Returns boolean
- Defined in src/types/key/Hash.ts:139

toBytes

toBytes(): Uint8Array
Converts the Hash instance to a byte array.

Returns
The byte array representation of the hash.

Returns Uint8Array
- Defined in src/types/key/Hash.ts:60

toHex

toHex(): string
Converts the Hash instance to a hexadecimal string.

Returns
The hexadecimal string representation of the hash.

Returns string
- Defined in src/types/key/Hash.ts:52

toJSON

toJSON(): string
Converts the Hash instance to its JSON representation.

Returns
The JSON string representation of the hash.

Returns string
- Defined in src/types/key/Hash.ts:68

`Static` createHashArray

createHashArray(byteArray: Uint8Array): Hash[]
Creates an array of Hash instances from a byte array.

Returns
An array of Hash instances created from the byte array.

Throws
Error if the byte array length is not a multiple of the hash length.
Parameters
- byteArray: Uint8Array
  
  The byte array containing multiple hash values.
Returns Hash[]
- Defined in src/types/key/Hash.ts:118

`Static` fromBuffer

fromBuffer(buffer: Buffer): Hash
Creates a Hash instance from a Buffer.

Returns
A new Hash instance.

Throws
Error if the buffer length is less than the required hash length.
Parameters
- buffer: Buffer
  
  The Buffer containing the hash bytes.
Returns Hash
- Defined in src/types/key/Hash.ts:105

`Static` fromBytes

fromBytes(source: Uint8Array): IResultWithBytes<Hash>
Creates a Hash instance from a byte array.

Returns
A result object containing the new Hash instance and the remaining bytes.

Throws
Error if the byte array length does not match the expected hash length.
Parameters
- source: Uint8Array
  
  The byte array representing the hash.
Returns IResultWithBytes<Hash>
- Defined in src/types/key/Hash.ts:87

`Static` fromHex

fromHex(source: string): Hash
Creates a Hash instance from a hexadecimal string.

Returns
A new Hash instance.

Throws
Error if the string length does not match the expected hash length.
Parameters
- source: string
  
  The hexadecimal string representation of the hash.
Returns Hash
- Defined in src/types/key/Hash.ts:38

`Static` fromJSON

fromJSON(json: string): Hash
Creates a Hash instance from its JSON representation.

Returns
A new Hash instance.
Parameters
- json: string
  
  The JSON string representation of the hash.
Returns Hash
- Defined in src/types/key/Hash.ts:77

Generated using TypeDoc