Skip to content
Bitfield that allocates a series of small buffers to support sparse bits without allocating a massive buffer
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.


Bitfield implementation that allocates a series of 1kb buffers to support sparse bitfields without allocating a massive buffer. If you want to simple implementation of a flat bitfield see the bitfield module.

This module is mostly useful if you need a big bitfield where you won't nessecarily set every bit.

npm install sparse-bitfield

build status


var bitfield = require('sparse-bitfield')
var bits = bitfield()

bits.set(0, true) // set first bit
bits.set(1, true) // set second bit
bits.set(1000000000000, true) // set the bit

Running the above example will allocate two 1kb buffers internally. Each 1kb buffer can hold information about 8192 bits so the first one will be used to store information about the first two bits and the second will be used to store the bit.


var bits = bitfield([options])

Create a new bitfield. Options include

  pageSize: 1024, // how big should the partial buffers be
  buffer: anExistingBitfield,
  trackUpdates: false // track when pages are being updated in the pager

bits.set(index, value)

Set a bit to true or false.


Get the value of a bit.


A memory-pager instance that is managing the underlying memory. If you set trackUpdates to true in the constructor you can use .lastUpdate() on this instance to get the last updated memory page.

var buffer = bits.toBuffer()

Get a single buffer representing the entire bitfield.



You can’t perform that action at this time.