Socket
Socket
Sign inDemoInstall

grpc-tools

Package Overview
Dependencies
1
Maintainers
2
Versions
45
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

grpc-tools


Version published
Weekly downloads
217K
increased by23.61%
Maintainers
2
Created
Weekly downloads
 

Package description

What is grpc-tools?

The grpc-tools npm package provides tools for working with gRPC, including compiling Protocol Buffers (protobuf) files and generating gRPC service code. It is particularly useful for setting up gRPC services and clients in Node.js applications.

What are grpc-tools's main functionalities?

Compile Protobuf Files

This feature allows you to compile Protocol Buffers (protobuf) files into JavaScript code. The generated code can then be used to create gRPC clients and servers.

const grpc_tools_node_protoc = require('grpc-tools');
const execSync = require('child_process').execSync;

execSync(
  'grpc_tools_node_protoc --js_out=import_style=commonjs,binary:. --grpc_out=. -I ./protos ./protos/helloworld.proto'
);

Generate gRPC Service Code

This feature generates the gRPC service code from protobuf definitions. The generated code includes both client and server stubs, which can be used to implement gRPC services.

const grpc_tools_node_protoc = require('grpc-tools');
const execSync = require('child_process').execSync;

execSync(
  'grpc_tools_node_protoc --plugin=protoc-gen-grpc=`which grpc_tools_node_protoc_plugin` --grpc_out=. -I ./protos ./protos/helloworld.proto'
);

Other packages similar to grpc-tools

Readme

Source

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 with require('@grpc/grpc-js') instead of require('grpc')
  • generate_package_definition: Generates code that does not require any gRPC library, and instead generates PackageDefinition objects that can be passed to the loadPackageDefinition function provided by both the grpc and @grpc/grpc-js libraries.

FAQs

Last updated on 31 Jan 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc