Conversions from/to bingint to TypedArray/Buffer, hex
Remarks
This module runs perfectly in node.js and browsers
- base64ToBigint
- bigintToBase64
- bigintToBuf
- bigintToHex
- bigintToText
- bufToBigint
- bufToHex
- bufToText
- hexToBigint
- hexToBuf
- parseHex
- textToBigint
- textToBuf
Ƭ TypedArray: Int8Array | Uint8Array | Uint8ClampedArray | Int16Array | Uint16Array | Int32Array | Uint32Array | Float32Array | Float64Array | BigInt64Array | BigUint64Array
A TypedArray object describes an array-like view of an underlying binary data buffer.
▸ base64ToBigint(a): bigint
Converts a base64 string to bigint.
| Name | Type | Description |
|---|---|---|
a |
string |
base64 string. It accepts standard and URL-safe base64 with and without padding |
bigint
a bigint
▸ bigintToBase64(a, urlsafe?, padding?): string
Converts an arbitrary-size non-negative bigint to a base64 string
| Name | Type | Default value | Description |
|---|---|---|---|
a |
bigint |
undefined |
a non negative bigint |
urlsafe |
boolean |
false |
if true Base64 URL encoding is used ('+' and '/' are replaced by '-', '_') |
padding |
boolean |
true |
if false, padding (trailing '=') is removed |
string
a base64 representation of the input bigint
Throws
Thrown if a < 0
▸ bigintToBuf(a, returnArrayBuffer?): ArrayBuffer | Buffer
Converts an arbitrary-size non-negative bigint to an ArrayBuffer or a Buffer (default for Node.js)
| Name | Type | Default value | Description |
|---|---|---|---|
a |
bigint |
undefined |
|
returnArrayBuffer |
boolean |
false |
In Node.js, it forces the output to be an ArrayBuffer instead of a Buffer. |
ArrayBuffer | Buffer
an ArrayBuffer or a Buffer with a binary representation of the input bigint
Throws
RangeError if a < 0.
▸ bigintToHex(a, prefix0x?, byteLength?): string
Converts a non-negative bigint to a hexadecimal string
| Name | Type | Default value | Description |
|---|---|---|---|
a |
bigint |
undefined |
a non negative bigint |
prefix0x |
boolean |
false |
set to true to prefix the output with '0x' |
byteLength? |
number |
undefined |
pad the output to have the desired byte length. Notice that the hex length is double the byte length. |
string
hexadecimal representation of the input bigint
Throws
RangeError if a < 0
▸ bigintToText(a): string
Converts a non-negative bigint representing a binary array of utf-8 encoded text to a string of utf-8 text
| Name | Type | Description |
|---|---|---|
a |
bigint |
A non-negative bigint representing a binary array of utf-8 encoded text. |
string
a string text with utf-8 encoding
Throws
RangeError if a < 0.
▸ bufToBigint(buf): bigint
Converts an ArrayBuffer, TypedArray or Buffer (node.js) to a bigint
| Name | Type |
|---|---|
buf |
TypedArray | ArrayBuffer | Buffer |
bigint
a bigint
▸ bufToHex(buf, prefix0x?, byteLength?): string
Returns the hexadecimal representation of a buffer.
| Name | Type | Default value | Description |
|---|---|---|---|
buf |
TypedArray | ArrayBuffer | Buffer |
undefined |
|
prefix0x |
boolean |
false |
set to true to prefix the output with '0x' |
byteLength? |
number |
undefined |
pad the output to have the desired byte length. Notice that the hex length is double the byte length. |
string
a string with a hexadecimal representation of the input buffer
▸ bufToText(buf): string
Converts an ArrayBuffer, TypedArray or Buffer (in Node.js) containing utf-8 encoded text to a string of utf-8 text
| Name | Type | Description |
|---|---|---|
buf |
TypedArray | ArrayBuffer | Buffer |
A buffer containing utf-8 encoded text |
string
a string text with utf-8 encoding
▸ hexToBigint(hexStr): bigint
Converts a hexadecimal string to a bigint
| Name | Type |
|---|---|
hexStr |
string |
bigint
a bigint
Throws
RangeError if input string does not hold an hexadecimal number
▸ hexToBuf(hexStr, returnArrayBuffer?): ArrayBuffer | Buffer
Converts a hexadecimal string to a buffer
| Name | Type | Default value | Description |
|---|---|---|---|
hexStr |
string |
undefined |
A string representing a number with hexadecimal notation |
returnArrayBuffer |
boolean |
false |
In Node.js, it forces the output to be an ArrayBuffer instead of a Buffer. |
ArrayBuffer | Buffer
An ArrayBuffer or a Buffer
Throws
RangeError if input string does not hold an hexadecimal number
▸ parseHex(a, prefix0x?, byteLength?): string
Parses a hexadecimal string for correctness and returns it with or without '0x' prefix, and/or with the specified byte length
| Name | Type | Default value | Description |
|---|---|---|---|
a |
string |
undefined |
the string with an hexadecimal number to be parsed |
prefix0x |
boolean |
false |
set to true to prefix the output with '0x' |
byteLength? |
number |
undefined |
pad the output to have the desired byte length. Notice that the hex length is double the byte length. |
string
Throws
RangeError if input string does not hold an hexadecimal number
Throws
RangeError if requested byte length is less than the input byte length
▸ textToBigint(text): bigint
Converts a utf-8 string to a bigint (from its binary representaion)
| Name | Type | Description |
|---|---|---|
text |
string |
A string text with utf-8 encoding |
bigint
a bigint representing a binary array of the input utf-8 encoded text
▸ textToBuf(str, returnArrayBuffer?): ArrayBuffer | Buffer
Converts a string of utf-8 encoded text to an ArrayBuffer or a Buffer (default in Node.js)
| Name | Type | Default value | Description |
|---|---|---|---|
str |
string |
undefined |
A string of text (with utf-8 encoding) |
returnArrayBuffer |
boolean |
false |
When invoked in Node.js, it can force the output to be an ArrayBuffer instead of a Buffer. |
ArrayBuffer | Buffer
an ArrayBuffer or a Buffer containing the utf-8 encoded text