bitfields
Easy-to-use bitfields for Node.js and browsers.
Installation
For Node.js or webpack projects, install with the NPM package manager:
npm install --save bitfields
For use in the browser without a bundler, include this script tag in your HTML.
<script src="https://unpkg.com/bitfields@1.0.3/dist/bitfields.js"></script>
Usage
const { Bitfield } = require('bitfields')
import { Bitfield } from 'bitfields'
const { Bitfield } = window.Bitfields
const bitfield = new Bitfield(64)
bitfield.set(1)
bitfield.set(1, 1)
bitfield.set(1, true)
bitfield.set(3)
console.log(bitfield.get(1))
console.log(bitfield.get(2))
console.log(bitfield.get(3))
bitfield.set(3, false)
bitfield.set(3, 0)
console.log(bitfield.get(3))
const buffer = bitfield.toBuffer()
const bigint = bitfield.toBigInt()
const hex = bitfield.toHex()
const string = bitfield.toString()
console.log(buffer)
console.log(bigint)
console.log(hex)
console.log(string)
const bitfieldFromBuffer = Bitfield.fromBuffer(buffer)
const bitfieldFromBigInt = Bitfield.fromBigInt(bigint)
const bitfieldFromHex = Bitfield.fromHex(hex)
const bitfieldFromString = Bitfield.fromString(string)