Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@google-cloud/paginator

googleapis25.2mApache-2.05.0.2TypeScript support: included

A result paging utility used by Google node.js modules

readme

Google Cloud Platform logo

Google Cloud Common Paginator: Node.js Client

release level npm version

A result paging utility used by Google node.js modules

A comprehensive list of changes in each version may be found in the CHANGELOG.

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.

Table of contents:

Quickstart

Installing the client library

npm install @google-cloud/paginator

Using the client library

const {paginator} = require('@google-cloud/paginator');
console.log(paginator);

Samples

Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.

Sample Source Code Try it
Quickstart source code Open in Cloud Shell
Streamify source code Open in Cloud Shell

The Google Cloud Common Paginator Node.js Client API Reference documentation also contains samples.

Supported Node.js Versions

Our client libraries follow the Node.js release schedule. Libraries are compatible with all current active and maintenance versions of Node.js. If you are using an end-of-life version of Node.js, we recommend that you update as soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on a best-efforts basis with the following warnings:

  • Legacy versions are not tested in continuous integration.
  • Some security patches and features cannot be backported.
  • Dependencies cannot be kept up-to-date.

Client libraries targeting some end-of-life versions of Node.js are available, and can be installed through npm dist-tags. The dist-tags follow the naming convention legacy-(version). For example, npm install @google-cloud/paginator@legacy-8 installs client libraries for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning.

This library is considered to be stable. The code surface will not change in backwards-incompatible ways unless absolutely necessary (e.g. because of critical security issues) or with an extensive deprecation period. Issues and requests against stable libraries are addressed with the highest priority.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

Please note that this README.md, the samples/README.md, and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template. To edit one of these files, make an edit to its templates in directory.

License

Apache Version 2.0

See LICENSE

changelog

Changelog

npm history

5.0.2 (2024-05-23)

Bug Fixes

  • Query should be on the list of extra args (#365) (50e40d0)

5.0.1 (2024-05-22)

Bug Fixes

  • Should pass extra callback arguments back to consumer (#361) (cc5c48b)

5.0.0 (2023-08-09)

⚠ BREAKING CHANGES

  • update to Node 14 (#346)

Miscellaneous Chores

4.0.1 (2022-09-09)

Bug Fixes

4.0.0 (2022-05-17)

⚠ BREAKING CHANGES

  • update library to use Node 12 (#325)

Build System

3.0.7 (2022-02-14)

Bug Fixes

  • update signature of end to comply with update node types definition (#311) (79e6fbd)

3.0.6 (2021-09-09)

Bug Fixes

  • build: switch primary branch to main (#287) (1b796f3)

3.0.5 (2020-09-02)

Bug Fixes

3.0.4 (2020-08-06)

Bug Fixes

  • destroy ResourceStream with pre-flight error (#236) (d57beb4)

3.0.3 (2020-07-24)

Bug Fixes

  • move gitattributes files to node templates (#234) (30e881c)

3.0.2 (2020-07-06)

Bug Fixes

3.0.1 (2020-05-20)

Bug Fixes

3.0.0 (2020-03-25)

⚠ BREAKING CHANGES

  • dep: upgrade gts 2.0.0 (#194)
  • deps: deprecated node 8 to 10; upgrade typescript

Miscellaneous Chores

  • dep: upgrade gts 2.0.0 (#194) (4eaf9be)
  • deps: deprecated node 8 to 10; upgrade typescript (f6434ab)

2.0.3 (2019-12-05)

Bug Fixes

  • deps: pin TypeScript below 3.7.0 (e06e1b0)

2.0.2 (2019-11-13)

Bug Fixes

2.0.1 (2019-08-25)

Bug Fixes

2.0.0 (2019-07-12)

⚠ BREAKING CHANGES

  • rewrite streaming logic (#136)

Code Refactoring

1.0.2 (2019-06-26)

Bug Fixes

  • docs: link to reference docs section on googleapis.dev (#132) (be231be)

1.0.1 (2019-06-14)

Bug Fixes

1.0.0 (2019-05-03)

Bug Fixes

  • deps: update dependency arrify to v2 (#109) (9f06c83)

Build System

BREAKING CHANGES

  • upgrade engines field to >=8.10.0 (#115)

v0.2.0

03-08-2019 12:15 PST

New Features

  • feat: handle promise based functions (#91)
  • refactor(ts): create generic for object streams (#101)

Dependencies

  • chore(deps): update dependency through2 to v3 (#53)
  • chore(deps): update dependency @types/is to v0.0.21 (#55)
  • chore(deps): update dependency gts to ^0.9.0 (#57)
  • fix: Pin @types/sinon to last compatible version (#61)
  • refactor: trim a few dependencies (#60)
  • chore(deps): update dependency @types/sinon to v5.0.7 (#62)
  • chore(deps): update dependency @types/sinon to v7 (#81)
  • chore(deps): update dependency mocha to v6

Documentation

  • docs: add lint/fix example to contributing guide (#85)
  • chore: move CONTRIBUTING.md to root (#87)
  • docs: update links in contrib guide (#94)
  • docs: update contributing path in README (#88)

Internal / Testing Changes

  • chore: include build in eslintignore (#49)
  • chore: update CircleCI config (#52)
  • chore: use latest npm on Windows (#54)
  • chore: update eslintignore config (#56)
  • chore: add synth.metadata
  • fix(build): fix system key decryption (#64)
  • chore: update license file (#68)
  • chore(build): update prettier config (#69)
  • chore: nyc ignore build/test by default (#71)
  • chore: always nyc report before calling codecov (#72)
  • build: add Kokoro configs for autorelease (#75)
  • fix(build): fix Kokoro release script (#76)
  • chore: fix publish.sh permission +x (#77)
  • chore: update nyc and eslint configs (#79)
  • chore(build): inject yoshi automation key (#80)
  • build: check broken links in generated docs (#82)
  • build: ignore googleapis.com in doc link check (#84)
  • build: test using @grpc/grpc-js in CI (#89)
  • build: create docs test npm scripts (#90)
  • build: use linkinator for docs test (#93)
  • build: update release configuration
  • build: fix types for sinon (#98)
  • build: use node10 to run samples-test, system-test etc (#97)
  • build: Add docuploader credentials to node publish jobs (#99)

v0.1.2

Bug fixes

  • fix: call limiter.makeRequest() instead of original method (#43)

Internal / Testing Changes

  • chore: update issue templates (#42)
  • chore: remove old issue template (#40)
  • build: run tests on node11 (#39)
  • chores(build): run codecov on continuous builds (#36)
  • chores(build): do not collect sponge.xml from windows builds (#37)
  • chore: update new issue template (#35)
  • chore(deps): update dependency sinon to v7 (#31)
  • build: fix codecov uploading on Kokoro (#32)
  • Update kokoro config (#29)
  • Update CI config (#27)
  • Don't publish sourcemaps (#25)
  • build: prevent system/sample-test from leaking credentials
  • Update kokoro config (#23)
  • test: remove appveyor config (#22)
  • Update CI config (#21)
  • Enable prefer-const in the eslint config (#20)
  • Enable no-var in eslint (#19)
  • Update CI config (#18)

v0.1.1

Internal / Testing Changes

  • Add synth script and update CI config (#14)
  • chore(deps): update dependency nyc to v13 (#12)
  • chore: ignore package-lock.json (#11)
  • chore(deps): lock file maintenance (#10)
  • chore: update renovate config (#9)
  • remove that whitespace (#8)
  • chore(deps): lock file maintenance (#7)
  • chore(deps): update dependency typescript to v3 (#6)
  • chore: assert.deelEqual => assert.deepStrictEqual (#5)
  • chore: move mocha options to mocha.opts (#4)