1+ [ // ] : # " This README.md file is auto-generated, all changes to this file will be lost. "
2+ [ // ] : # " To regenerate it, use `python -m synthtool`. "
13<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 " />
24
3- # @google-cloud/common-paginator
4- > A result paging utility used by Google node.js modules
5+ # [ Google Cloud Common Paginator: Node.js Client] ( https://github.com/googleapis/nodejs-paginator )
56
6- Google Cloud Common node.js module contains stuff used by other Cloud API modules.
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/master.svg?style=flat )] ( https://codecov.io/gh/googleapis/nodejs-paginator )
710
8- * [ github.com/googlecloudplatform/google-cloud-node] ( https://github.com/googlecloudplatform/google-cloud-node )
11+
12+
13+
14+ A result paging utility used by Google node.js modules
15+
16+
17+
18+
19+ * [ github.com/googleapis/nodejs-paginator] ( https://github.com/googleapis/nodejs-paginator )
920
1021Read more about the client libraries for Cloud APIs, including the older
1122Google APIs Client Libraries, in [ Client Libraries Explained] [ explained ] .
1223
1324[ explained ] : https://cloud.google.com/apis/docs/client-libraries-explained
1425
15- ### Installing the package
26+ ** Table of contents:**
27+
28+
29+ * [ Quickstart] ( #quickstart )
30+
31+ * [ Installing the client library] ( #installing-the-client-library )
32+ * [ Using the client library] ( #using-the-client-library )
33+ * [ Samples] ( #samples )
34+ * [ Versioning] ( #versioning )
35+ * [ Contributing] ( #contributing )
36+ * [ License] ( #license )
37+
38+ ## Quickstart
39+
40+ ### Installing the client library
41+
42+ ``` bash
43+ npm install @google-cloud/paginator
44+ ```
45+
46+
47+ ### Using the client library
48+
49+ ``` javascript
50+ const {paginator } = require (' @google-cloud/paginator' );
51+ console .log (paginator);
52+
53+ ```
54+
55+
56+
57+ ## Samples
58+
59+ Samples are in the [ ` samples/ ` ] ( https://github.com/googleapis/nodejs-paginator/tree/master/samples ) directory. The samples' ` README.md `
60+ has instructions for running the samples.
61+
62+ | Sample | Source Code | Try it |
63+ | --------------------------- | --------------------------------- | ------ |
64+ | Quickstart | [ source code] ( https://github.com/googleapis/nodejs-paginator/blob/master/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 ) |
65+
1666
17- It's unlikely you will need to install this package directly, as it will be
18- installed as a dependency when you install other ` @google-cloud ` packages.
1967
2068## Versioning
2169
2270This library follows [ Semantic Versioning] ( http://semver.org/ ) .
2371
24- This library is considered to be in ** alpha** . This means it is still a
25- work-in-progress and under active development. Any release is subject to
26- backwards-incompatible changes at any time.
72+
73+ This library is considered to be ** General Availability (GA)** . This means it
74+ is stable; the code surface will not change in backwards-incompatible ways
75+ unless absolutely necessary (e.g. because of critical security issues) or with
76+ an extensive deprecation period. Issues and requests against ** GA** libraries
77+ are addressed with the highest priority.
78+
79+
80+
81+
2782
2883More Information: [ Google Cloud Platform Launch Stages] [ launch_stages ]
2984
@@ -37,4 +92,12 @@ Contributions welcome! See the [Contributing Guide](https://github.com/googleapi
3792
3893Apache Version 2.0
3994
40- See [ LICENSE] ( https://github.com/googlecloudplatform/google-cloud-node/blob/master/LICENSE )
95+ See [ LICENSE] ( https://github.com/googleapis/nodejs-paginator/blob/master/LICENSE )
96+
97+
98+
99+ [ shell_img ] : https://gstatic.com/cloudssh/images/open-btn.png
100+ [ projects ] : https://console.cloud.google.com/project
101+ [ billing ] : https://support.google.com/cloud/answer/6293499#enable-billing
102+
103+ [ auth ] : https://cloud.google.com/docs/authentication/getting-started
0 commit comments