Skip to content
a very simple bitfield implementation using buffers
JavaScript
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.npmignore
.travis.yml
LICENSE Add MIT License Nov 12, 2013
index.js
package.json
readme.md remove testling (doesn't work anymore) Feb 20, 2018
tests.js Use `standard` style Aug 14, 2015

readme.md

bitfield

a very simple bitfield, compliant with the Bittorrent spec

npm install bitfield

Example

var Bitfield = require("bitfield");

var field = new Bitfield(256); //create a bitfield with 256 bits

field.set(128); //set the 128th bit
field.set(128, true); //same as above

field.get(128); //true
field.get(200); //false (all values are initialised to `false`)
field.get(1e3); //false (out-of-bounds is also false)

field.set(128, false); //set the 128th bit to 0 again

field.buffer; //the buffer used by bitfield

Methods

Bitfield(data): data can be either a node.js buffer, WebGL Int8Array or numeric array, or a number representing the maximum number of supported bytes.

Bitfield#get(index): Returns a boolean indicating whether the bit is set.

Bitfield#set(index[, value]): value defaults to true. Sets the bit to 1 for a value of true or 0 for false.

Auto-grow mode

Bitfield(data, { grow: size }): If you set an index that is out-of-bounds, the Bitfield will automatically grow so that the bitfield is big enough to contain the given index, up to the given size (in bit). If you want the Bitfield to grow indefinitely, pass Infinity as the size.

Properties

Bitfield#buffer: The contents of the bitfield.

Bitfield#grow: The passed growth option (defaults to 0).

License

MIT

You can’t perform that action at this time.