JSDoc: Module: util/arraybuffer-to-and-from-hex-string

Module: util/arraybuffer-to-and-from-hex-string

Source:

util/arraybuffer-to-and-from-hex-string.ts, line 8

Members

(static, constant) HexStringRegex

Regular expression for testing HexString string.

Source:

util/arraybuffer-to-and-from-hex-string.ts, line 28

Methods

(static) isHexString(input) → {boolean}

Parameters:

Name	Type	Description
`input`	string	the string to test.

Check if the passed input string is a hexadecimal string.

Source:

util/arraybuffer-to-and-from-hex-string.ts, line 33

Returns:

Type: boolean

(static) ensureHexString(input) → {HexString}

Parameters:

Name	Type	Description
`input`	string	the string to test.

Ensure that the passed string is a hexadecimal string.

Source:

util/arraybuffer-to-and-from-hex-string.ts, line 42

Returns:

Type: HexString

(static) uint8arrayToHexString(buffer) → {HexString}

Parameters:

Name	Type	Description
`buffer`	Uint8Array	The Uint8Array to convert to a hex string.

Converts contents of Uint8Array to a hexadecimal string.

Source:

util/arraybuffer-to-and-from-hex-string.ts, line 55

Returns:

Type: HexString

(static) hexToUint8Array(input) → {Uint8Array}

Parameters:

Name	Type	Description
`input`	HexString	The string that shall be converted. It must consist of an even number of the characters 0-9, a-f, A-F.

Converts a hexadecimal string to an Uint8Array.

Source:

util/arraybuffer-to-and-from-hex-string.ts, line 70

Returns:

Type: Uint8Array

(static) hexToUint8ArrayWithCheck(input) → {Uint8Array}

Parameters:

Name	Type	Description
`input`	string	The string that shall be converted. It must consist of an even number of the characters 0-9, a-f, A-F.

Converts a hexadecimal string to an Uint8Array with an additional regex test.

Source:

util/arraybuffer-to-and-from-hex-string.ts, line 90

Returns:

Type: Uint8Array