grpc-tools
v1.12.4
Published
Tools for developing with gRPC on Node.js
Downloads
883,177
Readme
grpc-tools
This package distributes the Protocol Buffers compiler protoc
along with the
plugin for generating client and service objects for use with the Node gRPC
libraries.
Usage
This library exports the grpc_tools_node_protoc
executable, which accepts all
of the same arguments as protoc
itself. For use with Node, you most likely
want to use CommonJS-style imports. An example of generating code this way can
be found in this guide.
The grpc_tools_node_protoc
automatically includes the Node gRPC plugin, so
it also accepts the --grpc_out=[option:]path
argument. The option can be
one of the following:
grpc_js
: Generates code withrequire('@grpc/grpc-js')
instead ofrequire('grpc')
generate_package_definition
: Generates code that does notrequire
any gRPC library, and instead generatesPackageDefinition
objects that can be passed to theloadPackageDefinition
function provided by both thegrpc
and@grpc/grpc-js
libraries.