1
0
Fork 0
mirror of https://github.com/actions/setup-node synced 2024-11-10 07:32:40 +00:00
setup-node/node_modules/octokit-pagination-methods/README.md
Danny McCormick 78148dae50
Add auth support (#21)
* Updates

* Update

* Update

* Update

* Update

* Yarn sometimes prefers npmrc, so use same token

* Description

* Update readme

* Feedback

* Add type

* new toolkit and scoped registries

* npmrc in RUNNER_TEMP

* Dont always auth

* Try exporting blank token

* Get auth working for now pending runner changes

* Fix string interpolation for auth token.

* Don't export both userconfigs

* Update authutil.js

* Add single quotes for authString

* Fix the registry string.

* Use userconfig and append trailing slash

* Keep in root of repo

* Try just adding auth token

* Remove auth token

* Try changes again

* Add tests

* Npm and GPR samples

* Add types
2019-08-06 18:26:04 -04:00

42 lines
1.6 KiB
Markdown

# octokit-pagination-methods
> Legacy Octokit pagination methods from v15
[![Build Status](https://travis-ci.com/gr2m/octokit-pagination-methods.svg?branch=master)](https://travis-ci.com/gr2m/octokit-pagination-methods)
[![Coverage Status](https://coveralls.io/repos/gr2m/octokit-pagination-methods/badge.svg?branch=master)](https://coveralls.io/github/gr2m/octokit-pagination-methods?branch=master)
[![Greenkeeper badge](https://badges.greenkeeper.io/gr2m/octokit-pagination-methods.svg)](https://greenkeeper.io/)
Several pagination methods such as `octokit.hasNextPage()` and `octokit.getNextPage()` have been removed from `@octokit/request` in v16.0.0 in favor of `octokit.paginate()`. This plugin brings back the methods to ease the upgrade to v16.
## Usage
```js
const Octokit = require('@octokit/rest')
.plugin('octokit-pagination-methods')
const octokit = new Octokit()
octokit.issues.getForRepo()
.then(async response => {
// returns true/false
octokit.hasNextPage(response)
octokit.hasPreviousPage(response)
octokit.hasFirstPage(response)
octokit.hasLastPage(response)
// fetch other pages
const nextPage = await octokit.getNextPage(response)
const previousPage = await octokit.getPreviousPage(response)
const firstPage = await octokit.getFirstPage(response)
const lastPage = await octokit.getLastPage(response)
})
```
## Credit
These methods have originally been created for `node-github` by [@mikedeboer](https://github.com/mikedeboer)
while working at Cloud9 IDE, Inc. It was adopted and renamed by GitHub in 2017.
## LICENSE
[MIT](LICENSE)