node package manager
Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »



Treat a collection of Buffers as a single contiguous partially mutable Buffer or Typed Array. Works in the browser with browserify.

Where possible, operations execute without creating a new Buffer and copying everything over.


with Typed Arrays (Int16Array, et al)

pass optional number specifying which type of Array:

    var Buffers = require('jbuffers');
    var bufs = Buffers(6); // Float32Array 
    bufs.push(new Float32Array([1,2,3]));

the number must correspond to the appropriate index in the following array:

var typedArrayTypes = [
    Int8Array,     // 0  
    Int16Array,     // 1 
    Int32Array,     // 2 
    Uint8Array,     // 3 
    Uint16Array,    // 4  
    Uint32Array,    // 5  
    Float32Array,   // 6 
    Float64Array    // 7 


var Buffers = require('jbuffers');
var bufs = Buffers();
bufs.push(new Buffer([1,2,3]));
bufs.push(new Buffer([4,5,6,7]));
bufs.push(new Buffer([8,9,10]));



$ node examples/slice.js 
<Buffer 03 04 05 06 07 08>


var Buffers = require('jbuffers');
var bufs = Buffers([
    new Buffer([1,2,3]),
    new Buffer([4,5,6,7]),
    new Buffer([8,9,10]),

var removed = bufs.splice(2, 4);
    removed : removed.slice(),
    bufs : bufs.slice(),


$ node examples/splice.js
{ removed: <Buffer 03 04 05 06>,
  bufs: <Buffer 01 02 07 08 09 0a> }



Create a Buffers with an array of Buffers if specified, else [].

.push(buf1, buf2...)

Push buffers onto the end. Just like Array.prototype.push.

.unshift(buf1, buf2...)

Unshift buffers onto the head. Just like Array.prototype.unshift.

.slice(i, j)

Slice a range out of the buffer collection as if it were contiguous. Works just like the Array.prototype.slice version.

.splice(i, howMany, replacements)

Splice the buffer collection as if it were contiguous. Works just like Array.prototype.splice, even the replacement part!

.copy(dst, dstStart, start, end)

Copy the buffer collection as if it were contiguous to the dst Buffer with the specified bounds. Works just like Buffer.prototype.copy.


Get a single element at index i.

.set(i, x)

Set a single element's value at index i.

.indexOf(needle, offset)

Find a string or buffer needle inside the buffer collection. Returns the position of the search string or -1 if the search string was not found.

Provide an offset to skip that number of characters at the beginning of the search. This can be used to find additional matches.

This function will return the correct result even if the search string is spread out over multiple internal buffers.


Convert the buffer collection to a single buffer, equivalent with .slice(0, buffers.length);

.toString(encoding, start, end)

Decodes and returns a string from the buffer collection. Works just like Buffer.prototype.toString