protobuf-decode

0.0.3 • Public • Published

Protobuf-decode

Javascript version protobuf decoder. Aim: light-weight, file size no larger than 5kB. Just decode simple structs.

Usage

We don't use .proto file, instead, we use a JSON formatted message description, basically the same as protobuf.js json format.

To decode a protobuf, first you need to use build() method to build the message package, this step will automatically detect embedded message dependencies and handle them for furthur use.

Then, you can pick your message from the result of first step to actually decode a byte array. This process shoud be like:

import protobuf from './protobuf';
import msgPackage from './msg_struct';
 
// build the messages package
const builders = protobuf.build(msgPackage),
      builder = builders.HistoryData;
 
// decode using message builder
protobuf.decode(byteArr, builder)

history versions

  • 0.0.3 support base64 encoded strings as input
  • 0.0.2 support embedded elements docs
  • 0.0.1 first relest

Demo

It's written in es6 style code, so you need to npm install babel-node. To test, you can run:

babel-node --presets es2015 test.js

Readme

Keywords

Package Sidebar

Install

npm i protobuf-decode

Weekly Downloads

1

Version

0.0.3

License

ISC

Last publish

Collaborators

  • victorisildur_xl