github-request-all

github-request-all

Iterate and collect all pages of objects for a GitHub API request.

Example

var ghRequestAll = require('github-request-all')

var requestOpts = {
  url: 'https://api.github.com/users/alanshaw/repos',
  headers: {
    'User-Agent': 'Your application UA' // Required by github
  }
}

ghRequestAll(requestOpts, function (err, results) {
  if (err) throw err
  console.log(results) // All repos for alanshaw
})

ghRequestAll(requestOpts, cb)

Request all pages of the paginated github request. requestOpts are options passed to request and should, at minimum include the URL to request. cb receives the results array.

ghRequestAll(requestOpts, opts, cb)

As above, but the second parameter opts are options for github-request-all:

opts.userAgent

Set the "User-Agent" header (default 'github-request-all').

opts.perPage

Set the number of items requested in a page (default 100).

opts.onPage

Callback called when each page is retrieved.

opts.filter

A function to filter the items collected (applied after opts.onPage is called). A callback for Array.prototype.filter.