Skip to content

Hex.toString

Decodes a Hex.Hex value into a string.

Imports

Named
import { Hex } from 'ox'

Examples

import { Hex } from 'ox'
 
Hex.toString('0x48656c6c6f20576f726c6421')

'Hello world!'
 Hex.toString('0x48656c6c6f20576f726c64210000000000000000000000000000000000000000', {
 size: 32,
})

'Hello world'

Definition

function toString(
  hex: Hex,
  options?: toString.Options,
): string

Source: src/Hex.ts

Parameters

hex

  • Type: Hex

The Hex.Hex value to decode.

options

  • Type: toString.Options
  • Optional

Options.

options.size

  • Type: number
  • Optional

Size (in bytes) of the hex value.

Return Type

The decoded string.

string

Error Type

Hex.toString.ErrorType