1 | <img src="https://avatars0.githubusercontent.com/u/1342004?v=3&s=96" alt="Google Inc. logo" title="Google" align="right" height="96" width="96"/>
|
2 |
|
3 | # Google API Extensions for Node.js
|
4 |
|
5 | [![Release Level][releaselevelimg]][releaselevel]
|
6 | [![npm version][npmimg]][npm]
|
7 |
|
8 | 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][grpc] and Google API conventions.
|
9 |
|
10 | 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][googleapis] can use services such as page streaming and request bundling to provide a more convenient and idiomatic API surface to callers.
|
11 |
|
12 | ## Installation
|
13 | ```sh
|
14 | $ npm install google-gax
|
15 | ```
|
16 |
|
17 | ## Supporting older version of Node.js
|
18 |
|
19 | This library uses [grpc-js](https://www.npmjs.com/package/@grpc/grpc-js) package for communicating with API server, and it uses HTTP/2 functionality
|
20 | 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
|
21 | on a legacy gRPC library ([grpc](https://www.npmjs.com/package/grpc)) and pass the instance of gRPC to the client constructor:
|
22 |
|
23 | ```js
|
24 | const grpc = require('grpc');
|
25 | const client = new APIClient({ grpc }); // APIClient is the client class you use, e.g. SpeechClient, etc.
|
26 | ```
|
27 |
|
28 | ## Contributing
|
29 | Contributions to this library are always welcome and highly encouraged. See the [CONTRIBUTING][contributing] documentation for more information on how to get started.
|
30 |
|
31 | ## Details
|
32 | For detailed documentation of the modules in gax-nodejs, please check out the [docs][docs].
|
33 |
|
34 | ## License
|
35 | BSD - See [LICENSE][license] for more information.
|
36 |
|
37 | [contributing]: https://github.com/googleapis/gax-nodejs/blob/main/CONTRIBUTING.md
|
38 | [docs]: http://googleapis.github.io/gax-nodejs/
|
39 | [license]: https://github.com/googleapis/gax-nodejs/blob/main/LICENSE
|
40 | [npmimg]: https://img.shields.io/npm/v/google-gax.svg
|
41 | [npm]: https://www.npmjs.org/package/google-gax
|
42 | [googleapis]: https://github.com/googleapis/googleapis/
|
43 | [grpc]: http://grpc.io
|
44 | [releaselevel]: https://cloud.google.com/terms/launch-stages
|
45 | [releaselevelimg]: https://img.shields.io/badge/release%20level-general%20availability%20%28GA%29-brightgreen.svg?style=flat
|