Package Exports
- @reapex/github-api
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@reapex/github-api) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
NodeJS Package - @reapex/github-api
Documentation :
- Here you can find the docs
Installation :
- Via NPM :
npm install @reapex/github-api
Import Package :
const { GithubAPI } = require("@reapex/github-api");
const client = new GithubAPI("GITHUB_API_TOKEN");Basic Usage :
/* All methods needs to be in Async Function */
async function main()
{
/* Retrieve Github User with Username */
await client.getUser('xReapex');
/* Will return User Object */
/* Retrieve Github Users Followers */
await client.getFollowers('xReapex');
/* Will return User(s) Object */
/* Check if User follow another */
await client.isFollowedBy('xReapex', 'xReapexTheFalse');
/* Will return Boolean: true/false */
/* Retrieve Users followed by User */
await client.getFollowing('xReapex');
/* Will return User(s) Object */
}
main()Search Functions :
- Find repositories with
name,resultats_per_page,pagesandsort!
/* Search Repositories */
await client.searchRepositories("@reapex/github-api", "10", "1", /* Optionnal (stars, forks, help-wanted-issues) Default (best-match) */ "asc");
/* Will return Repository(ies) Object */- Find commits with
name,resultats_per_page,pagesandsort!
/* Search Commits */
await client.searchCommit("github-api", "10", "1", /* Optionnal (stars, forks, help-wanted-issues) Default (best-match) */ "asc");
/* Will return Repository(ies) Object */