README.md 2.48 KB

Google Inc. logo

Google API Extensions for Node.js

Release Level npm version Code Coverage

Google API Extensions for Node.js (gax-nodejs) is a set of modules which aids the development of APIs for clients and servers based on gRPC and Google API conventions.

Application code will rarely need to use most of the classes within this library directly, but code generated automatically from the API definition files in Google APIs can use services such as page streaming and request bundling to provide a more convenient and idiomatic API surface to callers.

Installation

$ npm install google-gax

Supporting older version of Node.js

This library uses grpc-js package for communicating with API server, and it uses HTTP/2 functionality that is only available in Node.js v8.13.0 or newer. If you need to use this library with older versions of Node.js, you need to make your code depend on a legacy gRPC library (grpc) and pass the instance of gRPC to the client constructor:

const grpc = require('grpc');
const client = new APIClient({ grpc }); // APIClient is the client class you use, e.g. SpeechClient, etc.

Contributing

Contributions to this library are always welcome and highly encouraged. See the CONTRIBUTING documentation for more information on how to get started.

Details

For detailed documentation of the modules in gax-nodejs, please check out the docs.

License

BSD - See LICENSE for more information.