buffer-pipe v0.0.5

SYNOPSIS

A simple pipe for buffers. Write data to one end and read data off the other end.

INSTALL

npm install buffer-pipe

USAGE

const pipe = require('buffer-pipe')

const p = new Pipe()
p.write(Buffer.from([1,2,3,4]))
const buf = p.read(2)

// <1, 2>

API

constructor

index.js:8-12

Creates a new instance of a pipe

Parameters

• buf Buffer an optional buffer to start with (optional, default Buffer.from([]))

read

index.js:19-24

read num number of bytes from the pipe

Parameters

• num Number

Returns Buffer

write

index.js:30-34

Wites a buffer to the pipe

Parameters

• buf Buffer

end

index.js:40-42

Whether or not there is more data to read from the buffer returns {Boolean}

bytesRead

index.js:48-50

returns the number of bytes read from the stream

Returns Integer

bytesWrote

index.js:56-58

returns the number of bytes wrote to the stream

Returns Integer

LICENSE

MPL-2.0