uint8-varint

uint8-varint

Read/write varints from Uint8Arrays and Uint8ArrayLists

Table of contents

• Install
  • Browser <script> tag
• Usage
• API Docs
• License
• Contribution

Install

$ npm i uint8-varint

Browser <script> tag

Loading this module through a script tag will make it's exports available as Uint8Varint in the global namespace.

<script src="https://unpkg.com/uint8-varint/dist/index.min.js"></script>

Usage

import { Uint8ArrayList } from 'uint8arraylist'
import * as varint from 'uint8-varint'

const value = 12345

const buf = new Uint8ArrayList(
  new Uint8Array(2)
)
varint.signed.encode(value, buf)

varint.signed.decode(buf) // 12345

BigInts are also supported:

import { Uint8ArrayList } from 'uint8arraylist'
import * as varint from 'uint8-varint/big'

const value = 12345n

const buf = new Uint8ArrayList(
  new Uint8Array(2)
)
varint.signed.encode(value, buf)

varint.signed.decode(buf) // 12345n

API Docs

• https://achingbrain.github.io/uint8-varint

License

Licensed under either of

• Apache 2.0, (LICENSE-APACHE / http://www.apache.org/licenses/LICENSE-2.0)
• MIT (LICENSE-MIT / http://opensource.org/licenses/MIT)

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Changelog

1.0.8 (2023-08-15)

Bug Fixes

• update project config (#29) (1bfa423)