This tool generate TypeScript definitions for your Protocol Buffers models, when you use the excellent ProtoBuf.js library.
UPDATES -- Difference from the original
Original tool doesn't seem supported anymore.
- Made the package globally installable
- Fixed some bugs
- Published on NPM
Also, the build process was a mess. I fixed those. But I don't even send a PR, because I changed a lot of stuff.
npm install proto2typescript -g
# Parse and convert the proto file to json using pbjs (from ProtoBuf.js) pbjs model.proto > model.json # Convert the model to TypeScript definitions proto2typescript --file model.json > model.d.ts
Options: -f, --file The JSON file [required] -c, --camelCaseGetSet Generate getter and setters in camel case notation [default: true] -u, --underscoreGetSet Generate getter and setters in underscore notation [default: false] -p, --properties Generate properties [default: true]
See https://github.com/aliok/websocket-protobufs-ts-experiments for Gulp integration.
Because intelligent code completion is cool :-)
If you want to run the tests, you need bash, mocha and typescript.
npm install mocha -g npm install typescript -g
In order to run tests:
This code is developed in context of the BRIDGE project.
The source code of this tool is licenced under the MIT License.