bebyte

The bebyte is a lightweight TypeScript library for reading and writing unsigned integers from 1 to 64 bits in Big Endian format.

Features

• Supports unsigned integers of arbitrary bit width: i1 through i64
• Big Endian byte order (network order)
• Seamless encoding and decoding using Uint8Array
• Type-safe and optimized for binary protocols

Installation

To install the package using npm:

npm install bebyte

To install the package using pnpm:

pnpm install bebyte

To install the package using yarn:

yarn install bebyte

Usage

import bebyte from "bebyte";

const writer = bebyte.writer()
writer.i8(0xAB)
writer.i16(0xABCD)
writer.i24(0xABCDEF)
writer.i32(0xABCDEF01)
writer.i40(0xABCDEF0123n)
writer.i48(0xABCDEF012345n)
writer.i56(0xABCDEF01234567n)
writer.i64(0xABCDEF0123456789n)
const array = writer.toUint8Array()

const reader = bebyte.reader(array)
console.log(reader.i8())  // 171
console.log(reader.i16()) // 43981
console.log(reader.i24()) // 11259375
console.log(reader.i32()) // 2882400001
console.log(reader.i40()) // 737894400291n
console.log(reader.i48()) // 188900966474565n
console.log(reader.i56()) // 48358647417488743n
console.log(reader.i64()) // 12379813738877118345n

Contributing

1. Clone the repository:

git clone https://github.com/CKATEPTb/bebyte.git

2. Install dependencies::

pnpm install

3. Run the build::

pnpm run build

License

This project is licensed under the LGPL-3.0-only License.

See the LICENSE.md file for details.

Author

CKATEPTb, FakeIvchenko

Feel free to open issues and submit pull requests to improve the library!