@gsknnft/bigint-buffer 1.4.1 → 1.4.2

package/src/conversion/CODE_OF_CONDUCT.md

@@ -0,0 +1,134 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations
+

package/src/conversion/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Juan Hernández Serrano
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/src/conversion/README.md

@@ -0,0 +1,48 @@
+[![Licence: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)
+[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
+[![Node.js CI](https://github.com/juanelas/bigint-conversion/actions/workflows/build-and-test.yml/badge.svg)](https://github.com/juanelas/bigint-conversion/actions/workflows/build-and-test.yml)
+[![Coverage Status](https://coveralls.io/repos/github/juanelas/bigint-conversion/badge.svg?branch=main)](https://coveralls.io/github/juanelas/bigint-conversion?branch=main)
+
+# bigint-conversion
+
+Convert to/from non-negative integers represented with [ES-2020 native JS implementation of BigInt](https://tc39.es/ecma262/#sec-bigint-objects) from/to:
+
+- `Buffer` (node.js) or `ArrayBuffer|TypedArray` (native js),
+- hex `string`,
+- utf8-encoded text `string`,
+- standard and url-safe base64 with and without padding.
+
+It provides a common interface for the conversions that works for both **node.js** and **native javascript**.
+
+> Note that there is not a directly visible `TypedArray()` constructor, but a set of typed array ones: `Int8Array()`, `Uint8Array()`, `Uint8ClampedArray()`, `Int16Array()`, `Uint16Array()`, `Int32Array()`, `Uint32Array()`, `Float32Array()`, `Float64Array()`, `BigInt64Array()`, `BigUint64Array()`.
+
+## Usage
+
+`bigint-conversion` can be imported to your project with `npm`:
+
+```console
+npm install bigint-conversion
+```
+
+Then either require (Node.js CJS):
+
+```javascript
+const bigintConversion = require('bigint-conversion')
+```
+
+or import (JavaScript ES module):
+
+```javascript
+import * as bigintConversion from 'bigint-conversion'
+```
+
+The appropriate version for browser or node is automatically exported.
+
+> BigInt is [ES-2020](https://tc39.es/ecma262/#sec-bigint-objects). In order to use it with TypeScript you should set `target` (and probably also `lib`) to at least `es2020` in `tsconfig.json`.
+
+You can also download the [IIFE bundle](https://raw.githubusercontent.com/juanelas/bigint-conversion/main/dist\bundle.iife.js), the [ESM bundle](https://raw.githubusercontent.com/juanelas/bigint-conversion/main/dist\esm\bundle.min.js) or the [UMD bundle](https://raw.githubusercontent.com/juanelas/bigint-conversion/main/dist\bundle.umd.js) and manually add it to your project, or, if you have already installed `bigint-conversion` in your project, just get the bundles from `node_modules/bigint-conversion/dist/bundles/`.
+
+## API reference documentation
+
+[Check the API](./docs/API.md)

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