Package Exports

github-issues-stream

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (github-issues-stream) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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