Tiny GitHub API wrapper for server and client.
$ npm i gh.js
Then you can use it this way:
var GitHub = require("gh.js");
var gh = new GitHub({
token: "an optional token"
});
gh.get("users/IonicaBizau", function (err, repos) {
console.log(err || repos);
});
<script src="path/to/gh.js"></script>
<script>
(function () {
var gh = new GitHub();
gh.get("users/IonicaBizau", function (err, repos) {
console.log(err || repos);
});
})();
</script>
// Dependencies
var GitHub = require("gh.js");
// Create a new instance
var gh = new GitHub();
gh.get("users/IonicaBizau", function (err, repos) {
console.log(err || repos);
});
Creates a new instance of GitHub
.
- Object
options
: An object containing the following options: host
(String): The GitHub API host (default:"https://api.github.com/"
).token
(String): The GitHub token.user_agent
(String): The user agen (default:"gh.js"
).
- GitHub A new
GitHub
instance.
Makes a request to the GitHub API.
- String
url
: The request url. - Object
data
: The data object. - Function
callback
: The callback function.
- Request The request object.
Checks if the response is an error or not.
- Error
err
: The error value. - Object
data
: The data object. - Response
res
: The response object. - Function
callback
: The callback option.
Higher level function for making API requests.
- String
url
: The request url. - Object
options
: An object containing the following fields: all
(Boolean): Iftrue
, then the endpoint pages will be iterated and the results will be concatenated in one array.opts
(Object): An object containing querystring parameters to be stringified.data
(Object): The POST data (if provided the request will be a POST request).- Function
callback
: The callback function.
- Request The request object.
Have an idea? Found a bug? See how to contribute.
If you are using this library in one of your projects, add it in this list. ✨