gRPC for Node.js

Go to file

Michael Lumish 8cf0429fc5 Merge pull request #2989 from murgatroid99/grpc-js_fix_buffer_type_1.12.x grpc-js: Declare buffer type to avoid build error (1.12.x)		2025-08-04 11:05:54 -07:00
.github	build: harden grpc-tools-build.yml permissions	2022-12-08 19:04:47 +02:00
doc	chore: update environment.md doc	2024-07-05 14:15:40 +01:00
examples	Add interceptors example	2024-03-21 14:47:42 -07:00
packages	grpc-js: Declare buffer type to avoid build error	2025-08-04 10:07:01 -07:00
test	Fix copyright year	2024-09-16 15:42:16 -07:00
tools/release/native	Fix static linking and dockerfile	2023-01-30 22:01:57 +00:00
.editorconfig	Adding few stray files.	2017-09-13 02:06:15 +02:00
.gitattributes	Add .gitattributes marking generated code in xDS package	2021-08-10 09:48:56 -07:00
.gitignore	Begin aarch64 support	2023-01-22 22:54:12 +00:00
.gitmodules	grpc-js-xds: Switch from udpa to xds submodule	2021-11-01 14:26:08 -07:00
.istanbul.yml	Adding few stray files.	2017-09-13 02:06:15 +02:00
AUTHORS	Adding AUTHORS file.	2017-08-02 15:11:07 -07:00
CODE-OF-CONDUCT.md	Adding few stray files.	2017-09-13 02:06:15 +02:00
CONTRIBUTING.md	Add GOVERNANCE.md and CONTRIBUTING.md	2019-09-26 14:18:41 -07:00
GOVERNANCE.md	Add GOVERNANCE.md and CONTRIBUTING.md	2019-09-26 14:18:41 -07:00
LICENSE	Create LICENSE	2017-08-02 15:10:19 -07:00
MAINTAINERS.md	Fix typo	2024-06-24 14:50:59 -07:00
PACKAGE-COMPARISON.md	grpc-js: Prepare for 1.8.0 release	2022-12-01 16:02:45 -05:00
README.md	feat(grpc-reflection): created new grpc-reflection package ported from nestjs-grpc-reflection library	2023-11-08 22:39:06 -05:00
SECURITY.md	Add security policy doc	2021-01-22 10:57:55 -08:00
TROUBLESHOOTING.md	updated with an extra 's'	2021-09-02 23:00:11 +05:30
gulpfile.ts	run tests in series	2024-07-10 08:57:37 +01:00
merge_kokoro_logs.js	Try to fix error reporting in log merging script again	2019-06-12 11:36:58 -07:00
package.json	Merge pull request #2735 from murgatroid99/grpc-js_linkify-it_fix	2024-05-03 14:28:01 -07:00
run-tests.bat	Don't test on Node 18 yet	2022-10-17 10:11:38 -07:00
run-tests.sh	Revert version support change, run ring_hash tests conditionallly	2023-09-08 10:12:14 -07:00
setup.sh	Add license notice to several script files	2017-09-22 10:50:58 -07:00
setup_interop.sh	Add #!/bin/sh and copyright notice to new scripts	2019-05-09 17:46:25 -07:00
setup_interop_purejs.sh	Add #!/bin/sh and copyright notice to new scripts	2019-05-09 17:46:25 -07:00
tsconfig.json	simplify gulp commands in package directories	2017-12-14 16:41:24 -08:00
util.js	Adding missing license on a bunch of source files.	2019-03-19 01:06:57 +01:00

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.