pull-length-prefixed
Streaming length prefixed buffers with pull-streams
Table of Contents
Installation
$ npm install --save pull-length-prefixed
Usage
var pull = var lp = // encode // decode
API
encode([opts])
opts: Object
, optionalfixed: false
: If true uses a fixed 4 byte Int32BE prefix instead of varint
By default all messages will be prefixed with a varint. If you want to use a fixed length prefix you can specify this through the opts
.
Returns a pull-stream through.
decode([opts])
opts: Object
, optionalfixed: false
: If true uses a fixed 4 byte Int32BE prefix instead of varintmaxLength
: If provided, will not decode messages longer than the size specified, if omitted will use the current default of 4MB.
By default all messages will be prefixed with a varint. If you want to use a fixed length prefix you can specify this through the opts
.
Returns a pull-stream through.
decodeFromReader(reader, [opts], cb)
reader: [pull-reader](https://github.com/dominictarr/pull-reader)
opts: Object
, optional. Same as fordecode
.cb: Function
: Callback called with(err, message)
.
This uses a pull-reader instance to reade and decode a single message. Useful when using pull-handshake with length prefixed messages.
Contribute
PRs and issues gladly accepted! Check out the issues.
License
MIT © 2016 Friedel Ziegelmayer