gRPC for Node.js
Go to file
Michael Lumish a7dfb681b1
Merge pull request #3003 from murgatroid99/grpc-js-xds_register_wrr_locality
grpc-js-xds: Add wrr_locality to LB policy registry
2025-09-03 15:17:26 -07:00
.github bump actions/download-artifact and actions/upload-artifact from 2 to 4 in grpc-tools build workflow 2024-12-11 10:21:08 -05:00
doc fix case where serverHost is not an IP address + refactor 2025-01-10 10:39:20 +01:00
examples Add debugging example 2025-06-24 11:05:41 -07:00
packages grpc-js-xds: Add wrr_locality to LB policy registry 2025-09-03 13:58:42 -07:00
test grpc-js-xds: Add psm-light test job config 2025-06-09 15:09:55 -07:00
tools/release/native
.editorconfig
.gitattributes
.gitignore
.gitmodules
.istanbul.yml
AUTHORS
CODE-OF-CONDUCT.md
CONTRIBUTING.md
GOVERNANCE.md
LICENSE
MAINTAINERS.md
PACKAGE-COMPARISON.md
README.md remove badge 2024-11-07 18:41:41 +00:00
SECURITY.md
TROUBLESHOOTING.md
gulpfile.ts Install reflection before xds library 2025-02-04 12:55:13 -08:00
merge_kokoro_logs.js
package.json
run-tests.bat Don't install node-gyp 2025-07-21 11:43:45 -07:00
run-tests.sh Use nvm --delete-prefix option 2025-07-21 13:21:33 -07:00
setup.sh
setup_interop.sh
setup_interop_purejs.sh
tsconfig.json
util.js

README.md

gRPC on Node.js

Implementations

For a comparison of the features available in these two libraries, see this document

Pure JavaScript Client and Server

Directory: packages/grpc-js

npm package: @grpc/grpc-js

This library implements the core functionality of gRPC purely in JavaScript, without a C++ addon. It works on the latest versions of Node.js on all platforms that Node.js runs on.

C-based Client and Server (deprecated)

Directory: packages/grpc-native-core (lives in the grpc@1.24.x branch) (see here for installation information)

npm package: grpc.

This is the deprecated implementation of gRPC using a C++ addon. It works on versions of Node.js up to 14 on most platforms that Node.js runs on.

Other Packages

gRPC Protobuf Loader

Directory: packages/proto-loader

npm package: @grpc/proto-loader

This library loads .proto files into objects that can be passed to the gRPC libraries.

gRPC Tools

Directory: packages/grpc-tools

npm package: grpc-tools

Distribution of protoc and the gRPC Node protoc plugin for ease of installation with npm.

gRPC Health Check Service

Directory: packages/grpc-health-check

npm package: grpc-health-check

Health check service for gRPC servers.

gRPC Reflection API Service

Directory: packages/grpc-reflection

npm package: @grpc/reflection

Reflection API service for gRPC servers.