Base methods for creating node.js apps that work with the GitHub API.
(Table of contents generated by verb)
Heads up!
This lib was completely refactored in v0.2.0. Please see the API documentation for more details.
About
This library provides the necessary methods for creating your own GitHub API library or more specific functionality built on top of these methods.
- .request: the base handler all of the GitHub API VERBS:
GET,PUT,POST,DELETE,PATCH - .get: proxy for
request('GET', path, data, cb) - .getAll: makes repeat
.get()requests until the page of data has been retrieved. - .del: proxy for
request('DEL', path, data, cb) - .patch: proxy for
request('PATCH', path, data, cb) - .post: proxy for
request('POST', path, data, cb) - .put: proxy for
request('PUT', path, data, cb)
Install with npm
$ npm i github-base --savevar GitHub = require('github-base');
var github = new GitHub({
username: YOUR_USERNAME,
password: YOUR_PASSWORD,
});
// or
var github = new GitHub({
token: YOUR_TOKEN
});- gists: Methods for working with the GitHub Gist API. Node.js/JavaScript | homepage
- github-config: Easily store or get Github config data from
.gitconfig. Useful when you want to store… more | homepage - github-contributors: Generate a markdown or JSON list of contributors for a project using the GitHub API. | homepage
Create an instance of GitHub with the given options.
Params
options{Object}
Example
var GitHub = require('github-base');
var github = new GitHub(options);Uses simple-get to make a single request to the GitHub API, based on the provided settings. Supports any of the GitHub API VERBs:
GET,PUT,POST,DELETE,PATCH
Params
method{String}url{String}: GitHub API URL to use.data{Options}: Request options.cb{Function}
Example
github.request('GET', '/user/orgs', function (err, res) {
//=> array of orgs
});Makes a single GET request to the GitHub API based on the
provided settings.
Params
path{String}: path to append to the GitHub API URL.data{Options}: Request options.cb{Function}
Example
// get orgs for the authenticated user
github.get('/user/orgs', function (err, res) {
//=> array of orgs
});
// get gists for the authenticated user
github.get('/gists', function (err, res) {
//=> array of gists
});Performs a request using simple-get, and then if necessary requests additional paged content based on the response. Data from all pages are concatenated together and buffered until the last page of data has been retrieved.
Params
path{String}: path to append to the GitHub API URL.cb{Function}
Example
// get all repos for the authenticated user
var url = '/user/repos?type=all&per_page=1000&sort=updated';
github.getAll(url, function(err, res) {
console.log(res);
});Makes a single DELETE request to the GitHub API based on the
provided settings.
Params
path{String}: path to append to the GitHub API URL.data{Options}: Request options.cb{Function}
Example
// un-follow someone
github.del('/user/following/someoneelse', function(err, res) {
console.log(res);
});Makes a single PATCH request to the GitHub API based on the
provided settings.
Params
path{String}: path to append to the GitHub API URL.data{Options}: Request options.cb{Function}
Example
// update a gist
var fs = require('fs');
var opts = {files: {'readme.md': { content: '# My Readme...' }}};
github.patch('/gists/bd139161a425896f35f8', opts, function(err, res) {
console.log(err, res);
});Makes a single POST request to the GitHub API based on the
provided settings.
Params
path{String}: path to append to the GitHub API URL.data{Options}: Request options.cb{Function}
Example
// create a new repo
var opts = { name: 'new-repo-name' };
github.post('/user/repos', opts, function(err, res) {
console.log(res);
});Makes a single PUT request to the GitHub API based on the
provided settings.
Params
path{String}: path to append to the GitHub API URL.data{Options}: Request options.cb{Function}
Example
// follow someone
github.put('/user/following/jonschlinkert', function(err, res) {
console.log(res);
});Convenience method for inheriting GitHub. Extends
prototype and static methods.
Params
Ctor{Object}
Example
var GitHub = require('github-base');
function MyApp() {
GitHub.call(this);
}
GitHub.extend(MyApp);Install dev dependencies:
$ npm i -d && npm testEvery other GitHub API library I found either had a huge dependency tree, tries to be everything to everyone, was too bloated with boilerplace code, was too opinionated or not maintained.
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Jon Schlinkert
Copyright © 2015 Jon Schlinkert Released under the MIT license.
This file was generated by verb-cli on September 14, 2015.