@gsknnft/bigint-buffer 1.2.0 → 1.3.0

package/src/conversion/docs/README.md

@@ -0,0 +1,34 @@
+**bigint-conversion**
+
+***
+
+# bigint-conversion
+
+## Type Aliases
+
+- [TypedArray](type-aliases/TypedArray.md)
+
+## Variables
+
+- [isNative](variables/isNative.md)
+
+## Functions
+
+- [base64ToBigint](functions/base64ToBigint.md)
+- [bigintToBase64](functions/bigintToBase64.md)
+- [bigintToBuf](functions/bigintToBuf.md)
+- [bigintToHex](functions/bigintToHex.md)
+- [bigintToText](functions/bigintToText.md)
+- [bufToBigint](functions/bufToBigint.md)
+- [bufToHex](functions/bufToHex.md)
+- [bufToText](functions/bufToText.md)
+- [hexToBigint](functions/hexToBigint.md)
+- [hexToBuf](functions/hexToBuf.md)
+- [parseHex](functions/parseHex.md)
+- [textToBigint](functions/textToBigint.md)
+- [textToBuf](functions/textToBuf.md)
+- [toBigIntBE](functions/toBigIntBE.md)
+- [toBigIntLE](functions/toBigIntLE.md)
+- [toBufferBE](functions/toBufferBE.md)
+- [toBufferLE](functions/toBufferLE.md)
+- [validateBigIntBuffer](functions/validateBigIntBuffer.md)

package/src/conversion/docs/functions/base64ToBigint.md

@@ -0,0 +1,27 @@
+[**bigint-conversion**](../README.md)
+
+***
+
+[bigint-conversion](../README.md) / base64ToBigint
+
+# Function: base64ToBigint()
+
+> **base64ToBigint**(`a`): `bigint`
+
+Defined in: index.ts:330
+
+Converts a base64 string to bigint.
+
+## Parameters
+
+### a
+
+`string`
+
+base64 string. It accepts standard and URL-safe base64 with and without padding
+
+## Returns
+
+`bigint`
+
+a bigint

package/src/conversion/docs/functions/bigintToBase64.md

@@ -0,0 +1,43 @@
+[**bigint-conversion**](../README.md)
+
+***
+
+[bigint-conversion](../README.md) / bigintToBase64
+
+# Function: bigintToBase64()
+
+> **bigintToBase64**(`a`, `urlsafe`, `padding`): `string`
+
+Defined in: index.ts:321
+
+Converts an arbitrary-size non-negative bigint to a base64 string
+
+## Parameters
+
+### a
+
+`bigint`
+
+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
+
+## Returns
+
+`string`
+
+a base64 representation of the input bigint
+
+## Throws
+
+Thrown if a < 0

package/src/conversion/docs/functions/bigintToBuf.md

@@ -0,0 +1,35 @@
+[**bigint-conversion**](../README.md)
+
+***
+
+[bigint-conversion](../README.md) / bigintToBuf
+
+# Function: bigintToBuf()
+
+> **bigintToBuf**(`a`, `returnArrayBuffer`): `ArrayBuffer` \| `Buffer`\<`ArrayBufferLike`\>
+
+Defined in: index.ts:144
+
+Converts an arbitrary-size non-negative bigint to an ArrayBuffer or a Buffer (default for Node.js)
+
+## Parameters
+
+### a
+
+`bigint`
+
+### returnArrayBuffer
+
+`boolean` = `false`
+
+In Node.js, it forces the output to be an ArrayBuffer instead of a Buffer.
+
+## Returns
+
+`ArrayBuffer` \| `Buffer`\<`ArrayBufferLike`\>
+
+an ArrayBuffer or a Buffer with a binary representation of the input bigint
+
+## Throws
+
+RangeError if a < 0.

package/src/conversion/docs/functions/bigintToHex.md

@@ -0,0 +1,43 @@
+[**bigint-conversion**](../README.md)
+
+***
+
+[bigint-conversion](../README.md) / bigintToHex
+
+# Function: bigintToHex()
+
+> **bigintToHex**(`a`, `prefix0x`, `byteLength?`): `string`
+
+Defined in: index.ts:177
+
+Converts a non-negative bigint to a hexadecimal string
+
+## Parameters
+
+### a
+
+`bigint`
+
+a non negative bigint
+
+### prefix0x
+
+`boolean` = `false`
+
+set to true to prefix the output with '0x'
+
+### byteLength?
+
+`number`
+
+pad the output to have the desired byte length. Notice that the hex length is double the byte length.
+
+## Returns
+
+`string`
+
+hexadecimal representation of the input bigint
+
+## Throws
+
+RangeError if a < 0

package/src/conversion/docs/functions/bigintToText.md

@@ -0,0 +1,31 @@
+[**bigint-conversion**](../README.md)
+
+***
+
+[bigint-conversion](../README.md) / bigintToText
+
+# Function: bigintToText()
+
+> **bigintToText**(`a`): `string`
+
+Defined in: index.ts:204
+
+Converts a non-negative bigint representing a binary array of utf-8 encoded text to a string of utf-8 text
+
+## Parameters
+
+### a
+
+`bigint`
+
+A non-negative bigint representing a binary array of utf-8 encoded text.
+
+## Returns
+
+`string`
+
+a string text with utf-8 encoding
+
+## Throws
+
+RangeError if a < 0.

package/src/conversion/docs/functions/bufToBigint.md

@@ -0,0 +1,25 @@
+[**bigint-conversion**](../README.md)
+
+***
+
+[bigint-conversion](../README.md) / bufToBigint
+
+# Function: bufToBigint()
+
+> **bufToBigint**(`buf`): `bigint`
+
+Defined in: index.ts:154
+
+Converts an ArrayBuffer, TypedArray or Buffer (node.js) to a bigint
+
+## Parameters
+
+### buf
+
+`ArrayBuffer` | `Buffer`\<`ArrayBufferLike`\> | [`TypedArray`](../type-aliases/TypedArray.md)
+
+## Returns
+
+`bigint`
+
+a bigint

package/src/conversion/docs/functions/bufToHex.md

@@ -0,0 +1,37 @@
+[**bigint-conversion**](../README.md)
+
+***
+
+[bigint-conversion](../README.md) / bufToHex
+
+# Function: bufToHex()
+
+> **bufToHex**(`buf`, `prefix0x`, `byteLength?`): `string`
+
+Defined in: index.ts:269
+
+Returns the hexadecimal representation of a buffer.
+
+## Parameters
+
+### buf
+
+`ArrayBuffer` | `Buffer`\<`ArrayBufferLike`\> | [`TypedArray`](../type-aliases/TypedArray.md)
+
+### prefix0x
+
+`boolean` = `false`
+
+set to true to prefix the output with '0x'
+
+### byteLength?
+
+`number`
+
+pad the output to have the desired byte length. Notice that the hex length is double the byte length.
+
+## Returns
+
+`string`
+
+a string with a hexadecimal representation of the input buffer

package/src/conversion/docs/functions/bufToText.md

@@ -0,0 +1,27 @@
+[**bigint-conversion**](../README.md)
+
+***
+
+[bigint-conversion](../README.md) / bufToText
+
+# Function: bufToText()
+
+> **bufToText**(`buf`): `string`
+
+Defined in: index.ts:239
+
+Converts an ArrayBuffer, TypedArray or Buffer (in Node.js) containing utf-8 encoded text to a string of utf-8 text
+
+## Parameters
+
+### buf
+
+A buffer containing utf-8 encoded text
+
+`ArrayBuffer` | `Buffer`\<`ArrayBufferLike`\> | [`TypedArray`](../type-aliases/TypedArray.md)
+
+## Returns
+
+`string`
+
+a string text with utf-8 encoding

package/src/conversion/docs/functions/hexToBigint.md

@@ -0,0 +1,29 @@
+[**bigint-conversion**](../README.md)
+
+***
+
+[bigint-conversion](../README.md) / hexToBigint
+
+# Function: hexToBigint()
+
+> **hexToBigint**(`hexStr`): `bigint`
+
+Defined in: index.ts:191
+
+Converts a hexadecimal string to a bigint
+
+## Parameters
+
+### hexStr
+
+`string`
+
+## Returns
+
+`bigint`
+
+a bigint
+
+## Throws
+
+RangeError if input string does not hold an hexadecimal number

package/src/conversion/docs/functions/hexToBuf.md

@@ -0,0 +1,37 @@
+[**bigint-conversion**](../README.md)
+
+***
+
+[bigint-conversion](../README.md) / hexToBuf
+
+# Function: hexToBuf()
+
+> **hexToBuf**(`hexStr`, `returnArrayBuffer`): `ArrayBuffer` \| `Buffer`\<`ArrayBufferLike`\>
+
+Defined in: index.ts:298
+
+Converts a hexadecimal string to a buffer
+
+## Parameters
+
+### hexStr
+
+`string`
+
+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.
+
+## Returns
+
+`ArrayBuffer` \| `Buffer`\<`ArrayBufferLike`\>
+
+An ArrayBuffer or a Buffer
+
+## Throws
+
+RangeError if input string does not hold an hexadecimal number

package/src/conversion/docs/functions/parseHex.md

@@ -0,0 +1,45 @@
+[**bigint-conversion**](../README.md)
+
+***
+
+[bigint-conversion](../README.md) / parseHex
+
+# Function: parseHex()
+
+> **parseHex**(`a`, `prefix0x`, `byteLength?`): `string`
+
+Defined in: index.ts:119
+
+Parses a hexadecimal string for correctness and returns it with or without '0x' prefix, and/or with the specified byte length
+
+## Parameters
+
+### a
+
+`string`
+
+the string with an hexadecimal number to be parsed
+
+### prefix0x
+
+`boolean` = `false`
+
+set to true to prefix the output with '0x'
+
+### byteLength?
+
+`number`
+
+pad the output to have the desired byte length. Notice that the hex length is double the byte length.
+
+## Returns
+
+`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

package/src/conversion/docs/functions/textToBigint.md

@@ -0,0 +1,27 @@
+[**bigint-conversion**](../README.md)
+
+***
+
+[bigint-conversion](../README.md) / textToBigint
+
+# Function: textToBigint()
+
+> **textToBigint**(`text`): `bigint`
+
+Defined in: index.ts:216
+
+Converts a utf-8 string to a bigint (from its binary representaion)
+
+## Parameters
+
+### text
+
+`string`
+
+A string text with utf-8 encoding
+
+## Returns
+
+`bigint`
+
+a bigint representing a binary array of the input utf-8 encoded text

package/src/conversion/docs/functions/textToBuf.md

@@ -0,0 +1,33 @@
+[**bigint-conversion**](../README.md)
+
+***
+
+[bigint-conversion](../README.md) / textToBuf
+
+# Function: textToBuf()
+
+> **textToBuf**(`str`, `returnArrayBuffer`): `ArrayBuffer` \| `Buffer`\<`ArrayBufferLike`\>
+
+Defined in: index.ts:253
+
+Converts a string of utf-8 encoded text to an ArrayBuffer or a Buffer (default in Node.js)
+
+## Parameters
+
+### str
+
+`string`
+
+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.
+
+## Returns
+
+`ArrayBuffer` \| `Buffer`\<`ArrayBufferLike`\>
+
+an ArrayBuffer or a Buffer containing the utf-8 encoded text

package/src/conversion/docs/functions/toBigIntBE.md

@@ -0,0 +1,27 @@
+[**bigint-conversion**](../README.md)
+
+***
+
+[bigint-conversion](../README.md) / toBigIntBE
+
+# Function: toBigIntBE()
+
+> **toBigIntBE**(`buf`): `bigint`
+
+Defined in: index.ts:63
+
+Convert a big-endian buffer into a BigInt
+
+## Parameters
+
+### buf
+
+`Buffer`
+
+The big-endian buffer to convert.
+
+## Returns
+
+`bigint`
+
+A BigInt with the big-endian representation of buf.

package/src/conversion/docs/functions/toBigIntLE.md

@@ -0,0 +1,27 @@
+[**bigint-conversion**](../README.md)
+
+***
+
+[bigint-conversion](../README.md) / toBigIntLE
+
+# Function: toBigIntLE()
+
+> **toBigIntLE**(`buf`): `bigint`
+
+Defined in: index.ts:36
+
+Convert a little-endian buffer into a BigInt.
+
+## Parameters
+
+### buf
+
+`Buffer`
+
+The little-endian buffer to convert
+
+## Returns
+
+`bigint`
+
+A BigInt with the little-endian representation of buf.

package/src/conversion/docs/functions/toBufferBE.md

@@ -0,0 +1,33 @@
+[**bigint-conversion**](../README.md)
+
+***
+
+[bigint-conversion](../README.md) / toBufferBE
+
+# Function: toBufferBE()
+
+> **toBufferBE**(`num`, `width`): `Buffer`
+
+Defined in: index.ts:98
+
+Convert a BigInt to a big-endian buffer.
+
+## Parameters
+
+### num
+
+`bigint`
+
+The BigInt to convert.
+
+### width
+
+`number`
+
+The number of bytes that the resulting buffer should be.
+
+## Returns
+
+`Buffer`
+
+A big-endian buffer representation of num.

package/src/conversion/docs/functions/toBufferLE.md

@@ -0,0 +1,33 @@
+[**bigint-conversion**](../README.md)
+
+***
+
+[bigint-conversion](../README.md) / toBufferLE
+
+# Function: toBufferLE()
+
+> **toBufferLE**(`num`, `width`): `Buffer`
+
+Defined in: index.ts:80
+
+Convert a BigInt to a little-endian buffer.
+
+## Parameters
+
+### num
+
+`bigint`
+
+The BigInt to convert.
+
+### width
+
+`number`
+
+The number of bytes that the resulting buffer should be.
+
+## Returns
+
+`Buffer`
+
+A little-endian buffer representation of num.

package/src/conversion/docs/functions/validateBigIntBuffer.md

@@ -0,0 +1,15 @@
+[**bigint-conversion**](../README.md)
+
+***
+
+[bigint-conversion](../README.md) / validateBigIntBuffer
+
+# Function: validateBigIntBuffer()
+
+> **validateBigIntBuffer**(): `boolean`
+
+Defined in: index.ts:49
+
+## Returns
+
+`boolean`

package/src/conversion/docs/type-aliases/TypedArray.md

@@ -0,0 +1,11 @@
+[**bigint-conversion**](../README.md)
+
+***
+
+[bigint-conversion](../README.md) / TypedArray
+
+# Type Alias: TypedArray
+
+> **TypedArray** = `Int8Array` \| `Uint8Array` \| `Uint8ClampedArray` \| `Int16Array` \| `Uint16Array` \| `Int32Array` \| `Uint32Array` \| `Float32Array` \| `Float64Array` \| `BigInt64Array` \| `BigUint64Array`
+
+Defined in: index.ts:106

package/src/conversion/docs/variables/isNative.md

@@ -0,0 +1,11 @@
+[**bigint-conversion**](../README.md)
+
+***
+
+[bigint-conversion](../README.md) / isNative
+
+# Variable: isNative
+
+> **isNative**: `boolean` = `false`
+
+Defined in: index.ts:10

package/src/conversion/example.cjs

@@ -0,0 +1,9 @@
+const bcu = require('.')
+
+const bi = 87213425n
+console.log(bi)
+
+const b64 = bcu.bigintToBase64(bi)
+console.log(b64)
+
+console.log(bcu.base64ToBigint(b64))

package/src/conversion/example.esm.js

@@ -0,0 +1,11 @@
+import { bigintToBase64, base64ToBigint } from './dist/esm/index.node.js'
+
+const bi = 87213425n
+console.log(bi)
+
+const b64 = bigintToBase64(bi)
+console.log(b64)
+
+console.log(base64ToBigint(b64))
+
+export {}