common/docs/util/modules/_hex_tobn_.md

Functions

hexToBn

▸ hexToBn(value?: * string | number | null, options?: * ToBnOptions | boolean): BN

Defined in hex/toBn.ts:36

name: hexToBn

signature: hexToBn (value?: string, _options: ToBnOptions | boolean = { isLe: false, isNegative: false }): BN

summary: Creates a BN.js bignumber object from a hex string.

description: null inputs returns a BN(0) result. Hex input values return the actual value converted to a BN. Anything that is not a hex string (including the 0x prefix) throws an error.

example:

import { hexToBn } from '@polkadot/util';

hexToBn('0x123480001f'); // => BN(0x123480001f)

Parameters:

Name	Type	Default value
Optional value	string | number | null	-
Default value options	ToBnOptions | boolean	{ isLe: false, isNegative: false }

Returns: BN

---