- Notifications
You must be signed in to change notification settings - Fork786
A higher-level wrapper around the Github API. Intended for the browser.
License
github-tools/github
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
Github.js provides a minimal higher-level wrapper around Github's API.
/* 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 is hosted on github pages, and is generated from JSDoc; any contributionsshould include updated JSDoc.
Github.js is available fromnpm orunpkg.
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>
## CompatibilityGithub.js is tested on Node:
- 6.x
- 5.x
- 4.x
- 0.12
The team behind Github.js has created a whole organization, calledGitHub Tools,dedicated to GitHub and its API. In the near future this repository could be moved under the GitHub Tools organizationas well. In the meantime, we recommend you to take a look at other projects of the organization.
About
A higher-level wrapper around the Github API. Intended for the browser.
Resources
License
Code of conduct
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Packages0
Uh oh!
There was an error while loading.Please reload this page.