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)
API
constructor
index.js:8-10
Creates a new instance of a pipe
Parameters
buf
Buffer an optional buffer to start with (optional, default Buffer.from([])
)
read
index.js:17-21
read num
number of bytes from the pipe
Parameters
Returns Buffer
write
index.js:27-30
Wites a buffer to the pipe
Parameters
end
index.js:36-38
Whether or not there is more data to read from the buffer
returns {Boolean}
LICENSE
MPL-2.0