Skip to content

fromHex

fromHex<to>(hex, toOrOpts): FromHexReturnType<to>

Decodes a hex string into a string, number, bigint, boolean, or byte array.

Type Parameters

to extends "string" | "number" | "bigint" | "boolean" | "bytes"

Parameters

hex: `0x${string}`

Hex string to decode.

toOrOpts: FromHexParameters<to>

Type to convert to or options.

Returns

FromHexReturnType<to>

Decoded value.

Examples

import { fromHex } from 'viem'
const data = fromHex('0x1a4', 'number')
// 420
import { fromHex } from 'viem'
const data = fromHex('0x48656c6c6f20576f726c6421', 'string')
// 'Hello world'
import { fromHex } from 'viem'
const data = fromHex('0x48656c6c6f20576f726c64210000000000000000000000000000000000000000', {
size: 32,
to: 'string'
})
// 'Hello world'

Defined in

node_modules/.pnpm/viem@2.21.1_bufferutil@4.0.8_typescript@5.5.4_utf-8-validate@6.0.4_zod@3.23.8/node_modules/viem/_types/utils/encoding/fromHex.d.ts:47