grpc
/
grpc-node
mirror of https://github.com/grpc/grpc-node.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
grpc-node/packages/grpc-js
History
murgatroid99 cadb9ac071 Merge branch 'master' into grpc-js_proxy_support 2020-02-05 11:32:18 -08:00
..
src Merge branch 'master' into grpc-js_proxy_support 2020-02-05 11:32:18 -08:00
test Differentiate more strongly between TCP and IPC addresses 2020-01-29 16:50:29 -08:00
LICENSE Don't fill in any templates in LICENSE files 2019-03-06 11:01:44 -08:00
README.md grpc-js: rename grpc-js-core to match npm 2018-11-01 16:56:57 -04:00
gulpfile.ts grpc-js: skip gulp tasks based on Node version 2019-05-18 11:25:06 -04:00
package.json Update grpc-js to 0.6.16 2020-02-04 10:18:00 -08:00
prettier.config.js build: add full gts configuration and fix TSLint issues 2019-11-07 22:14:24 +01:00
tsconfig.json build: add full gts configuration and fix TSLint issues 2019-11-07 22:14:24 +01:00
tslint.json build: add full gts configuration and fix TSLint issues 2019-11-07 22:14:24 +01:00

README.md

Pure JavaScript gRPC Client

Note: This is an beta-level release. Some APIs may not yet be present and there may be bugs. Please report any that you encounter

Installation

Node 10 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

  • Unary and streaming calls
  • Cancellation
  • Deadlines
  • TLS channel credentials
  • Call credentials (for auth)
  • Simple reconnection
  • Channel API

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.