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 d5fc72bd5c Add missing properties to ClientHttp2StreamMock 2018-11-14 14:28:38 -08:00
..
src grpc-js: rename grpc-js-core to match npm 2018-11-01 16:56:57 -04:00
test Add missing properties to ClientHttp2StreamMock 2018-11-14 14:28:38 -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: rename grpc-js-core to match npm 2018-11-01 16:56:57 -04:00
package.json grpc-js: rename grpc-js-core to match npm 2018-11-01 16:56:57 -04:00
tsconfig.json grpc-js: rename grpc-js-core to match npm 2018-11-01 16:56:57 -04: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.