ghutils

A collection of utility functions for dealing with the GitHub API

Used by:

ghissues - a Node.js library to interact with the GitHub Issues API
ghpulls - a Node.js library to interact with the GitHub Pull Request API
ghrepos - a Node.js library to interact with the GitHub Repos API
ghusers - a Node.js library to interact with the GitHub Users API
ghteams - a Node.js library to interact with the GitHub Teams API
ghreleases - a Node.js library to interact with the GitHub Releases API

API

makeOptions(auth, options)

Helper to make options to pass to jsonist given a GitHub auth from ghauth and any additional options.

handler(callback)

Takes a JSON response from the GitHub API and turns any errors and applies them properly to the callback.

ghpost(auth, url, data, options, callback)

Make a GitHub API compatible POST request to the given URL via jsonist, uses makeOptions() to extend the options. Requires a GitHub auth from ghauth and any additional options.

ghget(auth, url, options, callback)

Make a GitHub API compatible GET request to the given URL via jsonist, uses makeOptions() to extend the options. Requires a GitHub auth from ghauth and any additional options.

lister(auth, urlbase, options, callback)

Given a paginated url resource, recursively fetch all available pages of data and return an array containing the complete list.

apiRoot

The api root url 'https://api.github.com'.

License & Copyright

ghutils is Copyright (c) 2015 Rod Vagg @rvagg and licensed under the MIT licence. All rights not explicitly granted in the MIT license are reserved. See the included LICENSE.md file for more details.

Current Tags

4.0.0 ... latest (5 years ago)