grpc-node/examples
Michael Lumish d22becc98e Add debugging example 2025-06-24 11:05:41 -07:00
..
cancellation
deadline
debugging Add debugging example 2025-06-24 11:05:41 -07:00
error_handling
helloworld
interceptors Add interceptors example 2024-03-21 14:47:42 -07:00
keepalive
load_balancing Add load balancing example 2025-06-16 15:36:50 -07:00
metadata
protos
reflection
retry Add retry example 2025-01-29 12:40:24 -08:00
routeguide
xds
README.md
package.json

README.md

gRPC in 3 minutes (Node.js)

PREREQUISITES

  • node: This requires Node 8.13.0 or greater.

INSTALL

$ # Get the gRPC repository
$ export REPO_ROOT=grpc-node # REPO root can be any directory of your choice
$ git clone -b RELEASE_TAG_HERE https://github.com/grpc/grpc-node $REPO_ROOT
$ cd $REPO_ROOT

$ cd examples
$ npm install

TRY IT!

There are two ways to generate the code needed to work with protocol buffers in Node.js - one approach uses Protobuf.js to dynamically generate the code at runtime, the other uses code statically generated using the protocol buffer compiler protoc. The examples behave identically, and either server can be used with either client.

  • Run the server

    $ # from this directory
    $ node ./helloworld/dynamic_codegen/greeter_server.js &
    $ # OR
    $ node ./helloworld/static_codegen/greeter_server.js &
    
  • Run the client

    $ # from this directory
    $ node ./helloworld/dynamic_codegen/greeter_client.js
    $ # OR
    $ node ./helloworld/static_codegen/greeter_client.js
    

TUTORIAL

You can find a more detailed tutorial in gRPC Basics: Node.js