Docs: Added notes on how to use pbjs and pbts programmatically

protobufjs · Dec 20, 2016 · 24f2c03 · 24f2c03
1 parent 3544576
commit 24f2c03
Show file tree

Hide file tree

Showing 16 changed files with 42 additions and 37 deletions.
diff --git a/README.md b/README.md
@@ -313,7 +313,7 @@ Documentation
 
 * [Google's Developer Guide](https://developers.google.com/protocol-buffers/docs/overview)
 
-* [protobuf.js API Documentation](http://dcode.io/protobuf.js/)
+* [protobuf.js API Documentation](http://dcode.io/protobuf.js/) and [CHANGELOG](https://github.com/dcodeIO/protobuf.js/blob/master/CHANGELOG.md)
 
 * [Questions and answers on StackOverflow](http://stackoverflow.com/questions/tagged/protobuf.js)
 
@@ -396,6 +396,20 @@ Generates TypeScript definitions from annotated JavaScript files.
 usage: pbts [options] file1.js file2.js ...
 ```
 
+### Using pbjs and pbts programmatically
+
+Both utilities can be used programmatically by providing command line arguments and a callback to their respective `main` functions:
+
+```js
+var pbjs = require("protobufjs/cli/pbjs");
+
+pbjs.main([ "--target", "json-module", "path/to/myproto.proto" ], function(err, output) {
+    if (err)
+        throw err;
+    // do something with output
+});
+```
+
 ### Descriptors vs. static modules
 
 While .proto and JSON files require the full library (about 17.5kb gzipped), pretty much all code but the relatively short descriptors is shared and all features including reflection and the parser are available.

diff --git a/dist/protobuf.js b/dist/protobuf.js
diff --git a/dist/protobuf.js.map b/dist/protobuf.js.map
diff --git a/dist/protobuf.min.js b/dist/protobuf.min.js
diff --git a/dist/protobuf.min.js.gz b/dist/protobuf.min.js.gz
diff --git a/dist/protobuf.min.js.map b/dist/protobuf.min.js.map
diff --git a/dist/runtime/protobuf.js b/dist/runtime/protobuf.js
diff --git a/dist/runtime/protobuf.min.js b/dist/runtime/protobuf.min.js
diff --git a/dist/runtime/protobuf.min.js.gz b/dist/runtime/protobuf.min.js.gz
diff --git a/package.json b/package.json
@@ -37,7 +37,8 @@
     "types": "node bin/pbts --name protobufjs --out types/protobuf.js.d.ts src && tsc types/test.ts --lib es2015 --noEmit",
     "zuul": "zuul --ui tape --no-coverage --concurrency 4 -- tests/*.js",
     "zuul-local": "zuul --ui tape --concurrency 1 --local 8080 --disable-tunnel -- tests/*.js",
-    "make": "npm run lint && npm run test && npm run types && npm run build && npm run changelog"
+    "make": "npm run lint && npm run test && npm run types && npm run build",
+    "release": "npm run make && npm run changelog"
   },
   "dependencies": {
     "@protobufjs/aspromise": "^1.0.3",

diff --git a/src/message.js b/src/message.js
@@ -44,21 +44,16 @@ MessagePrototype.asJSON = function asJSON(options) {
         options = {};
     var fields = this.$type.fields,
         json   = {};
-    var keys;
-    if (options.defaults) {
-        keys = Object.keys(fields);
-    } else
-        keys = Object.keys(this);
+    var keys = Object.keys(options.defaults ? fields : this);
     for (var i = 0, key; i < keys.length; ++i) {
         var field = fields[key = keys[i]],
             value = this[key];
         if (field) {
             if (field.repeated) {
                 if (value && (value.length || options.defaults)) {
-                    var array = new Array(value.length);
+                    json[key] = [];
                     for (var j = 0, l = value.length; j < l; ++j)
-                        array[j] = field.jsonConvert(value[j], options);
-                    json[key] = array;
+                        json[key].push(field.jsonConvert(value[j], options));
                 }
             } else
                 json[key] = field.jsonConvert(value, options);

diff --git a/tests/data/ambiguous-names.js b/tests/data/ambiguous-names.js
@@ -90,7 +90,7 @@ $root.A = (function() {
             r instanceof Reader||(r=Reader.create(r))
             var c=l===undefined?r.len:r.pos+l,m=new $root.A
             while(r.pos<c){
-                var t=r.int32()
+                var t=r.uint32()
                 switch(t>>>3){
                     case 1:
                         m["whatever"]=r.string()
@@ -220,7 +220,7 @@ $root.B = (function() {
             r instanceof Reader||(r=Reader.create(r))
             var c=l===undefined?r.len:r.pos+l,m=new $root.B
             while(r.pos<c){
-                var t=r.int32()
+                var t=r.uint32()
                 switch(t>>>3){
                     case 1:
                         m["A"]=types[0].decode(r,r.uint32())

diff --git a/tests/data/mapbox/vector_tile.js b/tests/data/mapbox/vector_tile.js
@@ -100,7 +100,7 @@ $root.vector_tile = (function() {
                 r instanceof Reader||(r=Reader.create(r))
                 var c=l===undefined?r.len:r.pos+l,m=new $root.vector_tile.Tile
                 while(r.pos<c){
-                    var t=r.int32()
+                    var t=r.uint32()
                     switch(t>>>3){
                         case 3:
                             m["layers"]&&m["layers"].length?m["layers"]:m["layers"]=[]
@@ -300,7 +300,7 @@ $root.vector_tile = (function() {
                     r instanceof Reader||(r=Reader.create(r))
                     var c=l===undefined?r.len:r.pos+l,m=new $root.vector_tile.Tile.Value
                     while(r.pos<c){
-                        var t=r.int32()
+                        var t=r.uint32()
                         switch(t>>>3){
                             case 1:
                                 m["stringValue"]=r.string()
@@ -507,7 +507,7 @@ $root.vector_tile = (function() {
                     r instanceof Reader||(r=Reader.create(r))
                     var c=l===undefined?r.len:r.pos+l,m=new $root.vector_tile.Tile.Feature
                     while(r.pos<c){
-                        var t=r.int32()
+                        var t=r.uint32()
                         switch(t>>>3){
                             case 1:
                                 m["id"]=r.uint64()
@@ -731,7 +731,7 @@ $root.vector_tile = (function() {
                     r instanceof Reader||(r=Reader.create(r))
                     var c=l===undefined?r.len:r.pos+l,m=new $root.vector_tile.Tile.Layer
                     while(r.pos<c){
-                        var t=r.int32()
+                        var t=r.uint32()
                         switch(t>>>3){
                             case 15:
                                 m["version"]=r.uint32()

diff --git a/tests/data/package.js b/tests/data/package.js
@@ -251,7 +251,7 @@ $root.Package = (function() {
             r instanceof Reader||(r=Reader.create(r))
             var c=l===undefined?r.len:r.pos+l,m=new $root.Package
             while(r.pos<c){
-                var t=r.int32()
+                var t=r.uint32()
                 switch(t>>>3){
                     case 1:
                         m["name"]=r.string()
@@ -558,7 +558,7 @@ $root.Package = (function() {
                 r instanceof Reader||(r=Reader.create(r))
                 var c=l===undefined?r.len:r.pos+l,m=new $root.Package.Repository
                 while(r.pos<c){
-                    var t=r.int32()
+                    var t=r.uint32()
                     switch(t>>>3){
                         case 1:
                             m["type"]=r.string()

diff --git a/tests/data/rpc.js b/tests/data/rpc.js
@@ -155,7 +155,7 @@ $root.MyRequest = (function() {
             r instanceof Reader||(r=Reader.create(r))
             var c=l===undefined?r.len:r.pos+l,m=new $root.MyRequest
             while(r.pos<c){
-                var t=r.int32()
+                var t=r.uint32()
                 switch(t>>>3){
                     case 1:
                         m["path"]=r.string()
@@ -285,7 +285,7 @@ $root.MyResponse = (function() {
             r instanceof Reader||(r=Reader.create(r))
             var c=l===undefined?r.len:r.pos+l,m=new $root.MyResponse
             while(r.pos<c){
-                var t=r.int32()
+                var t=r.uint32()
                 switch(t>>>3){
                     case 2:
                         m["status"]=r.int32()

diff --git a/types/protobuf.js.d.ts b/types/protobuf.js.d.ts
@@ -1,5 +1,5 @@
 // $> pbts --name protobufjs --out types/protobuf.js.d.ts src
-// Generated Tue, 20 Dec 2016 13:19:01 UTC
+// Generated Tue, 20 Dec 2016 16:43:56 UTC
 declare module "protobufjs" {
 
     /**