length-prefixed-stream

Streaming length prefixed buffers

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
length-prefixed-stream
2.0.05 years ago9 years agoMinified + gzip package size for length-prefixed-stream in KB

Readme

length-prefixed-stream
Streaming equivalent of length-prefixed-message. This module allow you to send buffers with a varint length prefix to ensure that they will arrive unpartioned
npm install length-prefixed-stream

build status

Usage

var lpstream = require('length-prefixed-stream')

var encode = lpstream.encode() // create an encode stream to send data
var decode = lpstream.decode() // create an decode stream to receive data

encode.write('hello world') // send "hello world"

decode.on('data', function(data) {
  console.log(data.toString()) // will always print "hello world"
})

encode.pipe(decode) // for testing just pipe to our selves

API

transformStream = lpstream.encode()

Creates a new encoder transform stream.

transformStream = lpstream.decode()

Creates a new decoder transform stream.

License

MIT