package
Translates between file formats and generates static code as well as TypeScript definitions.
npm install protobufjs-cliGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
Command line add-on for protobuf.js. Generates static code, reflection bundles, and TypeScript definitions.
npm install --save-dev protobufjs-clinpx pbjs --helpTranslates between file formats and generates static code.
-t, --target Specifies the target format. Also accepts a path to require a custom target.
json JSON bundle
json-module JSON bundle as a module
proto2 Protocol Buffers, Version 2
proto3 Protocol Buffers, Version 3
static Static code without reflection (non-functional on its own)
static-module Static code without reflection as a module
-p, --path Adds a directory to the include path.
--filter Path to a JSON file listing messages and their dependencies to keep.
Example: {"messageNames":["mypackage.Message","Message2"]}
-o, --out Saves to a file instead of writing to stdout.
-d, --dts Also saves a .d.ts file next to --out for static-module and json-module.
--sparse Exports only those types referenced from a main file (experimental).
Module targets only:
-w, --wrap Specifies the wrapper to use. Also accepts a path to require a custom wrapper.
default Default wrapper supporting both CommonJS and AMD
commonjs CommonJS wrapper
amd AMD wrapper
esm ESM wrapper (implies --es6)
npx pbts --helpGenerates TypeScript definitions from annotated JavaScript files.
-o, --out Saves to a file instead of writing to stdout.
-g, --global Name of the global object in browser environments, if any.
-i, --import Comma delimited list of imports, optionally as localName=path.
--no-constructor Emits private constructors for reflection-backed declarations.
--no-comments Does not output any JSDoc comments.
Internal flags:
-n, --name Wraps everything in a module of the specified name.
-m, --main Whether building a standalone file without any imports.
usage: pbts [options] file1.js file2.js ... (or) other | pbts [options] -Generate static code and a matching declaration file:
npx pbjs -t static-module -w commonjs -o compiled.js --dts file1.proto file2.protoGenerate a reflection bundle and a matching declaration file:
npx pbjs -t json-module -w commonjs -o bundle.js --dts file1.proto file2.protoNote that declarations generated for JSON modules describe reflection-backed message types. Use MyMessage.create(...) instead of constructors.
For nested reflected properties like MyMessage.MyEnum, type, service and enum names must start with an uppercase letter. Otherwise, use reflection lookups such as root.lookupType(...).
The CLI also provides protoc-gen-pbjs for projects that already use protoc but prefer protobuf.js code generation.
The plugin is an aggregate generator: each invocation writes one JavaScript module and, with dts, one matching declaration file.
protoc \
--plugin=protoc-gen-pbjs=./node_modules/.bin/protoc-gen-pbjs \
--pbjs_out=gen \
--pbjs_opt=dts \
proto/awesome.protoBy default, the plugin emits index.js with target=static-module and wrap=esm. Use file=PATH to choose the aggregate output file, target=json-module for a JSON module, wrap=commonjs for CommonJS output, and keep-case to preserve descriptor field names.
Other pbjs code generation options can be passed as usual, for example root=NAME, dependency=ID, lint=CONFIG, no-create, force-long, or null-semantics. See the pbjs help output above for the full option set.
Both utilities can be used programmatically by providing command line arguments and a callback to their respective main functions:
const { pbjs, pbts } = require("protobufjs-cli");
pbjs.main(["--target", "json-module", "path/to/myproto.proto"], function(err, output) {
if (err) throw err;
// do something with output
});See the protobuf.js README for runtime variants, usage examples, and additional documentation.
fenster
npm@fenster.name