github-api-promise
Advanced tools
A node module for interfacing with the Github API using promises. The full GitHub API documentation can be found at https://developer.github.com/v3/.
npm install github-api-promise
TLDR;
Basic example code:
import api from "github-api-promise";
// Set settings
api.config.owner = 'OwnersGithubUsername';
api.config.repo = 'RepoName';
api.config.token = 'YourAccessToken';
api.config.debug = true; // Default is false. Logs request information via console.log when true.
// Do stuff
api.repos.releases.getRepositoryReleases()
.then((res) => {
// Do your stuff here. res is the JSON object returned by the API
})
.catch((err) => {
console.log(`Request failed: ${err}`);
});
For help creating an access token, see the GitHub help article Creating an Access Token for Command Line Use. This package only requires either the repo scope for private repos or the public_repo scope for public repos.
The following APIs are supported. PRs welcome!
Special thanks to jeejkang for the Stormtroopocat image!
Thanks to aktau/github-release (a library for GO) for the inspiration for this project.
FAQs
A node module for interfacing with the Github API
The npm package github-api-promise receives a total of 33 weekly downloads. As such, github-api-promise popularity was classified as not popular.
We found that github-api-promise demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.
Security News
Research
Socket researchers found a malicious Maven package impersonating the legitimate ‘XZ for Java’ library, introducing a backdoor for remote code execution.