Package Exports
- buffer-pipe
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (buffer-pipe) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
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
Creates a new instance of a pipe
Parameters
bufBuffer an optional buffer to start with (optional, defaultBuffer.from([]))
read
read num number of bytes from the pipe
Parameters
numNumber
Returns Buffer
write
Wites a buffer to the pipe
Parameters
bufBuffer
end
Whether or not there is more data to read from the buffer returns {Boolean}
bytesRead
returns the number of bytes read from the stream
Returns Integer
bytesWrote
returns the number of bytes wrote to the stream
Returns Integer