Files
common/docs/util/modules/_bn_tohex_.md
T
2018-12-25 12:34:05 +00:00

1.1 KiB

Functions

bnToHex

▸ bnToHex(value?: * BN | number | null, options?: * number | Options): string

Defined in bn/toHex.ts:34

name: bnToHex

signature: bnToHex (value?: BN, bitLength: number = -1): string

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

description: null inputs returns a 0x result, BN values return the actual value as a 0x prefixed hex value. Anything that is not a BN object throws an error. With bitLength set, it fixes the number to the specified length.

example:

import BN from 'bn.js';
import { bnToHex } from '@polkadot/util';

bnToHex(new BN(0x123456)); // => '0x123456'

Parameters:

Name Type Default value
Optional value BN | number | null -
Default value options number | Options { bitLength: -1, isLe: false, isNegative: false }

Returns: string