var pbs = require('pbs')var messages = pbs(` message Company { required string name = 1; repeated Employee employees = 2; optional string country = 3; message Employee { required string name = 1; required uint32 age = 2; } }`)// create a streaming encodervar encoder = messages.Company.encode()// create a streaming decodervar decoder = messages.Company.decode()
Encoding
Use pbs to encode a protocol buffers message (no matter how large!) to a stream.
The encoder stream will expose all properties of the protobuf message as methods on the
stream that you can pass the value you want to write to.
encoder.someProperty(aValue, [callback])
The callback is called when the stream has been flushed.
Here is an example using the above protobuf schema:
// all the properties of Company are exposed as methodsvar encoder = messages.Company.encode()// encoder is a readable stream containing the protobuf message.// you can pipe it anywhere!encoder.pipe(fs.createWriteStream('my-protobuf-message.pb'))// write a name to the streamencoder.name('my-company')// write an employee to the streamencoder.employees({ name: 'mathias', age: 28})// write another oneencoder.employees({ name: 'jane doe', age: 32})// no more data - will end the readable stream
The encoder stream produces a valid protobuf message that can be decoded with any
other parser that follows the protobuf spec.
Decoding
Similar to encoding you can use pbs to decode a protobuf message.
The decoder stream also exposes the properties as methods, but instead of passing a value
you pass a function that is called then that property is found in the stream.
decoder.someProperty(fn)
Here is an example using the above schema:
// all the properties of Company are exposes as methodsvar decoder = messages.Company.decode()decoder.name(function (name, cb) { console.log('message has name:', name) cb() // done processing})decoder.employees(function (employee, cb) { console.log('employee array member:', employee) cb() // done processing})decoder.country(function (country, cb) { console.log('message has country:', country) cb()})decoder.on
Use cases
You can use this to parse large protobuf messages that might not fit in memory.
Another use case is to use this to implement a streaming binary protocol encoder/decoder.
Let's say I wanted to implement a chat protocol. I could describe it using the following proto schema: