bigint-conversion

Convert to/from native JS implementation of bigint (ECMA-262) from/to:

• buffer (node.js) or uint8array (native js),
• hex string,
• utf8 text string.

It provides a common interface for the conversions that works for both node.js and javascript native.

Installation

bigint-conversion is distributed for web browsers and/or webviews supporting BigInt as an ES6 module or an IIFE file; and for Node.js as a CJS module.

bigint-conversion can be imported to your project with npm:

npm install bigint-conversion

NPM installation defaults to the ES6 module for browsers and the CJS one for Node.js.

For web browsers, you can also directly download the IIFE file or the ES6 module from GitHub.

BigInt is currently ECMA-262 and thus in order to use it with TypeScript you should set lib (and probably also target and module) to esnext in tsconfig.json.

bigint-conversion JS Doc

Functions

bigintToBuf(a) ⇒ Buffer | Uint8Array

Convert a bigint to a buffer (node.js) or uint8array (native js)

bufToBigint(buf) ⇒ bigint

Converts a buffer (node.js) or uint8array (native js) to a bigint

bigintToHex(a) ⇒ str

Convert a bigint to a hexadecimal string

hexToBigint(hex) ⇒ bigint

Converts a hexadecimal string to a bigint

bigintToText(a) ⇒ string

Converts a bigint representing a binary array of utf-8 encoded text to a string of utf-8 text

textToBigint(text) ⇒ bigint

Converts a utf-8 string to a bigint (from its buffer|uint8array binary representaion)

bufToText(buf) ⇒ string

Converts a buffer (node) or a uint8array (native js) containing utf-8 encoded text to a string of utf-8 text

textToBuf(str) ⇒ Buffer | Uint8Array

Converts a string of textwith utf-8 encoding to a buffer (node) or uint8array (native js)

bufToHex(a) ⇒ string

Returns the hexadecimal representation of a buffer (node) or uint8array (native js)

hexToBuf(hex_str) ⇒ Buffer | Uint8Array

Converts a hexadecimal string to a buffer (node) or uint8array (native js)

bigintToBuf(a) ⇒ Buffer | Uint8Array

Convert a bigint to a buffer (node.js) or uint8array (native js)

Kind: global function
Returns: Buffer | Uint8Array - A buffer (node.js) or uint8array (native js) with a binary representation of the input bigint

bufToBigint(buf) ⇒ bigint

Converts a buffer (node.js) or uint8array (native js) to a bigint

Kind: global function

bigintToHex(a) ⇒ str

Convert a bigint to a hexadecimal string

Kind: global function
Returns: str - A hexadecimal representation of the input bigint

hexToBigint(hex) ⇒ bigint

Converts a hexadecimal string to a bigint

Kind: global function
Returns: bigint - a

bigintToText(a) ⇒ string

Converts a bigint representing a binary array of utf-8 encoded text to a string of utf-8 text

Kind: global function
Returns: string - A string text with utf-8 encoding

textToBigint(text) ⇒ bigint

Converts a utf-8 string to a bigint (from its buffer|uint8array binary representaion)

Kind: global function
Returns: bigint - A bigint representing a binary array of the input utf-8 encoded text

bufToText(buf) ⇒ string

Converts a buffer (node) or a uint8array (native js) containing utf-8 encoded text to a string of utf-8 text

Kind: global function
Returns: string - A string text with utf-8 encoding

textToBuf(str) ⇒ Buffer | Uint8Array

Converts a string of textwith utf-8 encoding to a buffer (node) or uint8array (native js)

Kind: global function
Returns: Buffer | Uint8Array - a buffer containing the utf-8 encoded text

bufToHex(a) ⇒ string

Returns the hexadecimal representation of a buffer (node) or uint8array (native js)

Kind: global function
Returns: string - A string with a hexadecimal representation of the input buffer

hexToBuf(hex_str) ⇒ Buffer | Uint8Array

Converts a hexadecimal string to a buffer (node) or uint8array (native js)

Kind: global function
Returns: Buffer | Uint8Array - a buffer (node) or uint8array (native js)