antpb

Protocol Buffers for JavaScript. It from the dcodeIO protobufjs, we modify some files to achieve our need.

Install

1$ tnpm install antpb --save

Usage

• load all *.proto files in specified directory

1const protobuf = require('antpb');
2
3const root = protobuf.loadAll('/proto_file_path');
4
5const ProtoObj = root.lookup('com.alipay.test.service.ProtoObj');
6const map = new Map();
7map.set(false, {
8  name: 'Peter',
9  finalField: '123',
10});
11
12const req = ProtoObj.create({
13  testObj2: {
14    name: 'zongyu',
15    finalField: '321',
16  },
17  map3: map,
18});
19
20const buf = ProtoObj.encode(req).finish();
21const ret = ProtoObj.decode(buf); // => { testObj2: { name: 'zongyu', finalField: '321' }, map3: <Map> }

• load interface schame from JSON file

1const protobuf = require('@alipay/protobufjs');
2
3const root = protobuf.fromJSON(/proto_json_file_path);
4
5...

API

Top API

• loadAll(protoPath, [options]) load all *.proto files in specified directory
  • {String} protoPath - the proto folder
  • {Object} [options] - optional arguments
• fromJSON(jsonFile, [root]) load interface schame from JSON file
  • {String} jsonFile - JSON file path
  • {Root} [root] - root node, if it is not provided, will create the new one

Other API

refer: https://github.com/dcodeIO/protobuf.js