Github.js

Github.js provides a minimal higher-level wrapper around Github's API.

Usage

/* Data can be retrieved from the API either using callbacks (as in versions < 1.0) or using a new promise-based API. The promise-based API returns the raw Axios request promise. */importGitHubfrom'github-api';// unauthenticated clientconstgh=newGitHub();letgist=gh.getGist();// not a gist yetgist.create({public: true,description: 'My first gist',files: {"file1.txt": {content: "Aren't gists great!"}}}).then(function({data}){// Promises!letcreatedGist=data;returngist.read();}).then(function({data}){letretrievedGist=data;// do interesting things});

varGitHub=require('github-api');// basic authvargh=newGitHub({username: 'FOO',password: 'NotFoo'/* also acceptable: token: 'MY_OAUTH_TOKEN' */});varme=gh.getUser();// no user specified defaults to the user for whom credentials were providedme.listNotifications(function(err,notifications){// do some stuff});varclayreimann=gh.getUser('clayreimann');clayreimann.listStarredRepos(function(err,repos){// look at all the starred repos!});

API Documentation

API documentation is hosted on github pages, and is generated from JSDoc; any contributions should include updated JSDoc.

Installation

Github.js is available from npm or unpkg.

npm install github-api

<!-- just github-api source (5.3kb) --><scriptsrc="https://unpkg.com/github-api/dist/GitHub.min.js"></script><!-- standalone (20.3kb) --><scriptsrc="https://unpkg.com/github-api/dist/GitHub.bundle.min.js"></script>

Compatibility

Github.js is tested on Node.js:

• 6.x

Note: Github.js uses Promise, hence it will not work in Node.js < 4 without polyfill.