- 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. It was concieved in the context ofProse, a content editor for GitHub.
Github.js is available fromnpm ornpmcdn.
npm install github-api
<!-- just github-api source (5.3kb) --><scriptsrc="//npmcdn.com/github-api/dist/GitHub.min.js"></script><!-- standalone (20.3kb) --><scriptsrc="//npmcdn.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.
/* Data can be retrieved from the API either using callbacks (as in versions < 1.0) or using a new promise-based API. For now the promise-based API just returns the raw HTTP request promise; this might change in the next version. */importGitHubfrom'github-api';// unauthenticated clientconstgh=newGitHub();letgist=gh.getGist();// not a gist yetgist.create({public:true,description:'My first gist',files:{"file1.txt":{contents:"Aren't gists great!"}}}).then(function({data}){// Promises!letgistJson=data;gist.read(function(err,gist,xhr){// if no error occurred then err == null// gistJson === httpResponse.data// xhr === httpResponse});});
importGitHubfrom'github-api';// basic authconstgh=newGitHub({username:'FOO',password:'NotFoo'});constme=gh.getUser();me.listNotifications(function(err,notifcations){// do some stuff});constclayreimann=gh.getUser('clayreimann');clayreimann.getStarredRepos().then(function({data:reposJson}){// do stuff with reposJson});
varGitHub=require('github-api');// token authvargh=newGitHub({token:'MY_OAUTH_TOKEN'});varyahoo=gh.getOrganization('yahoo');yahoo.getRepos(function(err,repos){// look at all the repos!})
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.