1 | [//]: # "This README.md file is auto-generated, all changes to this file will be lost."
|
2 | [//]: # "To regenerate it, use `python -m synthtool`."
|
3 | <img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>
|
4 |
|
5 | # [Google Cloud Common Paginator: Node.js Client](https://github.com/googleapis/nodejs-paginator)
|
6 |
|
7 | [![release level](https://img.shields.io/badge/release%20level-general%20availability%20%28GA%29-brightgreen.svg?style=flat)](https://cloud.google.com/terms/launch-stages)
|
8 | [![npm version](https://img.shields.io/npm/v/@google-cloud/paginator.svg)](https://www.npmjs.org/package/@google-cloud/paginator)
|
9 | [![codecov](https://img.shields.io/codecov/c/github/googleapis/nodejs-paginator/main.svg?style=flat)](https://codecov.io/gh/googleapis/nodejs-paginator)
|
10 |
|
11 |
|
12 |
|
13 |
|
14 | A result paging utility used by Google node.js modules
|
15 |
|
16 |
|
17 | A comprehensive list of changes in each version may be found in
|
18 | [the CHANGELOG](https://github.com/googleapis/nodejs-paginator/blob/main/CHANGELOG.md).
|
19 |
|
20 | * [Google Cloud Common Paginator Node.js Client API Reference][client-docs]
|
21 |
|
22 | * [github.com/googleapis/nodejs-paginator](https://github.com/googleapis/nodejs-paginator)
|
23 |
|
24 | Read more about the client libraries for Cloud APIs, including the older
|
25 | Google APIs Client Libraries, in [Client Libraries Explained][explained].
|
26 |
|
27 | [explained]: https://cloud.google.com/apis/docs/client-libraries-explained
|
28 |
|
29 | **Table of contents:**
|
30 |
|
31 |
|
32 | * [Quickstart](#quickstart)
|
33 |
|
34 | * [Installing the client library](#installing-the-client-library)
|
35 | * [Using the client library](#using-the-client-library)
|
36 | * [Samples](#samples)
|
37 | * [Versioning](#versioning)
|
38 | * [Contributing](#contributing)
|
39 | * [License](#license)
|
40 |
|
41 | ## Quickstart
|
42 |
|
43 | ### Installing the client library
|
44 |
|
45 | ```bash
|
46 | npm install @google-cloud/paginator
|
47 | ```
|
48 |
|
49 |
|
50 | ### Using the client library
|
51 |
|
52 | ```javascript
|
53 | const {paginator} = require('@google-cloud/paginator');
|
54 | console.log(paginator);
|
55 |
|
56 | ```
|
57 |
|
58 |
|
59 |
|
60 | ## Samples
|
61 |
|
62 | Samples are in the [`samples/`](https://github.com/googleapis/nodejs-paginator/tree/main/samples) directory. Each sample's `README.md` has instructions for running its sample.
|
63 |
|
64 | | Sample | Source Code | Try it |
|
65 | | --------------------------- | --------------------------------- | ------ |
|
66 | | Quickstart | [source code](https://github.com/googleapis/nodejs-paginator/blob/main/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-paginator&page=editor&open_in_editor=samples/quickstart.js,samples/README.md) |
|
67 | | Streamify | [source code](https://github.com/googleapis/nodejs-paginator/blob/main/samples/streamify.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-paginator&page=editor&open_in_editor=samples/streamify.js,samples/README.md) |
|
68 |
|
69 |
|
70 |
|
71 | The [Google Cloud Common Paginator Node.js Client API Reference][client-docs] documentation
|
72 | also contains samples.
|
73 |
|
74 | ## Supported Node.js Versions
|
75 |
|
76 | Our client libraries follow the [Node.js release schedule](https://nodejs.org/en/about/releases/).
|
77 | Libraries are compatible with all current _active_ and _maintenance_ versions of
|
78 | Node.js.
|
79 |
|
80 | Client libraries targeting some end-of-life versions of Node.js are available, and
|
81 | can be installed via npm [dist-tags](https://docs.npmjs.com/cli/dist-tag).
|
82 | The dist-tags follow the naming convention `legacy-(version)`.
|
83 |
|
84 | _Legacy Node.js versions are supported as a best effort:_
|
85 |
|
86 | * Legacy versions will not be tested in continuous integration.
|
87 | * Some security patches may not be able to be backported.
|
88 | * Dependencies will not be kept up-to-date, and features will not be backported.
|
89 |
|
90 | #### Legacy tags available
|
91 |
|
92 | * `legacy-8`: install client libraries from this dist-tag for versions
|
93 | compatible with Node.js 8.
|
94 |
|
95 | ## Versioning
|
96 |
|
97 | This library follows [Semantic Versioning](http://semver.org/).
|
98 |
|
99 |
|
100 | This library is considered to be **General Availability (GA)**. This means it
|
101 | is stable; the code surface will not change in backwards-incompatible ways
|
102 | unless absolutely necessary (e.g. because of critical security issues) or with
|
103 | an extensive deprecation period. Issues and requests against **GA** libraries
|
104 | are addressed with the highest priority.
|
105 |
|
106 |
|
107 |
|
108 |
|
109 |
|
110 | More Information: [Google Cloud Platform Launch Stages][launch_stages]
|
111 |
|
112 | [launch_stages]: https://cloud.google.com/terms/launch-stages
|
113 |
|
114 | ## Contributing
|
115 |
|
116 | Contributions welcome! See the [Contributing Guide](https://github.com/googleapis/nodejs-paginator/blob/main/CONTRIBUTING.md).
|
117 |
|
118 | Please note that this `README.md`, the `samples/README.md`,
|
119 | and a variety of configuration files in this repository (including `.nycrc` and `tsconfig.json`)
|
120 | are generated from a central template. To edit one of these files, make an edit
|
121 | to its templates in
|
122 | [directory](https://github.com/googleapis/synthtool).
|
123 |
|
124 | ## License
|
125 |
|
126 | Apache Version 2.0
|
127 |
|
128 | See [LICENSE](https://github.com/googleapis/nodejs-paginator/blob/main/LICENSE)
|
129 |
|
130 | [client-docs]: https://cloud.google.com/nodejs/docs/reference/paginator/latest
|
131 |
|
132 | [shell_img]: https://gstatic.com/cloudssh/images/open-btn.png
|
133 | [projects]: https://console.cloud.google.com/project
|
134 | [billing]: https://support.google.com/cloud/answer/6293499#enable-billing
|
135 |
|
136 | [auth]: https://cloud.google.com/docs/authentication/getting-started
|