Node 12 is recommended. The exact set of compatible Node versions can be found in the
engines field of the
npm install @grpc/grpc-js
Documentation specifically for the
@grpc/grpc-js package is currently not available. However, documentation is available for the
grpc package, and the two packages contain mostly the same interface. There are a few notable differences, however, and these differences are noted in the "Migrating from grpc" section below.
- Automatic reconnection
- Partial compression support: clients can decompress response messages
- Pick first and round robin load balancing policies
- Client Interceptors
- Connection Keepalives
- HTTP Connect support (proxies)
If you need a feature from the
grpc package that is not provided by the
@grpc/grpc-js, please file a feature request with that information.
This library does not directly handle
.proto files. To use
.proto files with this library we recommend using the
@grpc/grpc-js is almost a drop-in replacement for
grpc, but you may need to make a few code changes to use it:
- If you are currently loading
grpc.load, that function is not available in this library. You should instead load your
@grpc/proto-loaderand load the resulting package definition objects into
- If you are currently loading packages generated by
grpc-tools, you should instead generate your files using the
grpc-tools, then load the object exported by the generated file into
- If you have a server and you are using
Server#bindto bind ports, you will need to use
- If you are using any channel options supported in
grpcbut not supported in
@grpc/grpc-js, you may need to adjust your code to handle the different behavior. Refer to the list of supported options below.
- Refer to the detailed package comparison for more details on the differences between
Supported Channel Options
Many channel arguments supported in
grpc are not supported in
@grpc/grpc-js. The channel arguments supported by
Some Notes on API Guarantees
The public API of this library follows semantic versioning, with some caveats:
- Some methods are prefixed with an underscore. These methods are internal and should not be considered part of the public API.
- The class
Callis only exposed due to limitations of TypeScript. It should not be considered part of the public API.
- In general, any API that is exposed by this library but is not exposed by the
grpclibrary is likely an error and should not be considered part of the public API.
grpc.experimentalnamespace contains APIs that have not stabilized. Any API in that namespace may break in any minor version update.