A TypeScript implementation of a byte (octet) allowing easy bit manipulations.
This library provides a simple implementation of a byte (aka octet) in a TypeScript class. I developed this "library" (which consists of merely one TypeScript class) for two purposes:
Hence: Feel free to use it, if it helps, but do not expect rocket science. :)
This library is available as a Node.js-module. You can thus use Node.js' package manager npm
to install the latest production version from the npm registry by executing
npm i @henningkerstan/byte
in your Node.js project's repository. This library does not require/install any dependencies.
Since this library is written in TypeScript, you can use it both with TypeScript as well as with plain JavaScript. Below you can find short examples to get you started in both languages.
The library also comes with an online documentation. A good starting point for further reading is the documentation of the Byte class. Moreover, as this documentation is generated from source code comments using TypeDoc, a supported editor (like Visual Studio Code) can provide on-the-fly information on functions, parameters, etc..
To use any of the functionality we need to import the module.
import { Byte } from "@henningkerstan/byte"
Here are some toy examples - you can also have a look at the Jasmine spec (aka test script) for more examples.
const byte1 = Byte.allZero()
byte1.setBit(1, 3)
console.log(byte1.toStringLSB())
const byte2 = Byte.fromUInt8LSB(123)
console.log(byte2.toStringLSB())
console.log(byte2.toStringMSB())
Contact the main author (Henning Kerstan) if you want to contribute. More details will be available here soon.
Note that this project uses semantic versioning.
Copyright 2021 Henning Kerstan
SPDX-License-Identifier: Apache-2.0
Generated using TypeDoc