mirror of
https://github.com/pezkuwichain/pezkuwi-common.git
synced 2026-04-22 02:07:56 +00:00
19 lines
757 B
TypeScript
19 lines
757 B
TypeScript
import type { HexString, NumberOptions, ToBn } from '../types.js';
|
|
import type { BN } from './bn.js';
|
|
/**
|
|
* @name bnToHex
|
|
* @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
|
|
* <BR>
|
|
*
|
|
* ```javascript
|
|
* import BN from 'bn.js';
|
|
* import { bnToHex } from '@pezkuwi/util';
|
|
*
|
|
* bnToHex(new BN(0x123456)); // => '0x123456'
|
|
* ```
|
|
*/
|
|
export declare function bnToHex<ExtToBn extends ToBn>(value?: ExtToBn | BN | bigint | number | null, { bitLength, isLe, isNegative }?: NumberOptions): HexString;
|