github-issues-stream v1.0.1

github-issues-stream

Readable GitHub issues stream.

Install

npm i --save github-issues-stream

Usage

githubIssues(repo, options)

Returns a Readable Stream of Github Issue objects.

Parameters:

• repo: The repo containing the issues you want to fetch.
• options:
  • token: For private repos, you must specify a token. Can be generated here: https://github.com/settings/tokens
  • query: Github API issues query parameters.

Example:

var githubIssues = require('github-issues-stream')
var repo = 'jprichardson/node-fs-extra'

console.log('\nfetching %s issues...\n', repo)

githubIssues(repo)
.on('data', function (issue) {
  console.log('  #%d: %s', issue.number, issue.title)
})
.on('error', function (err) {
  console.log('ERROR: ' + err)
})
.on('end', function () {
  console.log('\ndone!\n')
})

License

MIT

Copyright (c) JP Richardson