mirror of https://github.com/ButlerLogic/action-autotag.git synced 2024-11-23 00:31:07 +07:00

History

Corey Butler cda6f3fa13 WIP		2019-09-02 17:06:23 -05:00
..
lib	WIP	2019-09-02 17:06:23 -05:00
CODE_OF_CONDUCT.md	WIP	2019-09-02 17:06:23 -05:00
index.js	WIP	2019-09-02 17:06:23 -05:00
LICENSE	WIP	2019-09-02 17:06:23 -05:00
package.json	WIP	2019-09-02 17:06:23 -05:00
README.md	WIP	2019-09-02 17:06:23 -05:00
test.js	WIP	2019-09-02 17:06:23 -05:00

README.md

octokit-pagination-methods

Legacy Octokit pagination methods from v15

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

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 while working at Cloud9 IDE, Inc. It was adopted and renamed by GitHub in 2017.

LICENSE

MIT