JSPM

  • Created
  • Published
  • Downloads 16056244
  • Score
    100M100P100Q231890F
  • License Apache-2.0

gRPC Library for Node - pure JS implementation

Package Exports

  • @grpc/grpc-js
  • @grpc/grpc-js/build/src/call-credentials
  • @grpc/grpc-js/build/src/compression-filter
  • @grpc/grpc-js/build/src/make-client
  • @grpc/grpc-js/build/src/metadata
  • @grpc/grpc-js/package.json

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@grpc/grpc-js) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Pure JavaScript gRPC Client

Installation

Node 12 is recommended. The exact set of compatible Node versions can be found in the engines field of the package.json file.

npm install @grpc/grpc-js

Features

  • Clients
  • Automatic reconnection
  • Servers
  • Streaming
  • Metadata
  • Partial compression support: clients can decompress response messages
  • Pick first and round robin load balancing policies
  • Client Interceptors
  • Connection Keepalives
  • HTTP Connect support (proxies)

This library does not directly handle .proto files. To use .proto files with this library we recommend using the @grpc/proto-loader package.

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 Call is 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 grpc library is likely an error and should not be considered part of the public API.