JSPM

  • Created
  • Published
  • Downloads 20760583
  • Score
    100M100P100Q213480F
  • License Apache-2.0

Protocol Buffers for JavaScript. Finally.

Package Exports

  • protobufjs
  • protobufjs/dist/ProtoBuf
  • protobufjs/dist/ProtoBuf.js
  • protobufjs/index

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 (protobufjs) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

ProtoBuf.js - protobuf for JavaScript

Protocol Buffers are a language-neutral, platform-neutral, extensible way of serializing structured data for use in communications protocols, data storage, and more, originally designed at Google (see).

ProtoBuf.js is a pure JavaScript implementation on top of ByteBuffer.js including a .proto parser, message class building and simple encoding and decoding. There is no compilation step required, it's super easy to use and it works out of the box on .proto files!

Getting started

Features

  • RequireJS/AMD compatible
  • node.js/CommonJS compatible, also available via npm
  • Browser compatible
  • Closure Compiler compatible (fully annotated, externs)
  • Fully documented using jsdoc3
  • Well tested through test.js
  • ByteBuffer.js is the only production dependency
  • Fully compatible to the official implementation including advanced features
  • Small footprint (even smaller if you use a noparse build)
  • proto2js command line utility

Documentation

Tests Build Status

Downloads

Contributors

Daniel Wirtz (maintainer), Frank Xu, Dretch, shirmin, Nikolai Vavilov

License: Apache License, Version 2.0 - Logo derived from W3C HTML5 Logos (CC A 3.0)