github-web-api
v1.0.4
Published
Github Web Api Wrapper
Downloads
40
Readme
SORRY FOR BUGS. THEY ARE FIXED (IF U ARE USING VER 1.0.3 or LOWER PLS UPDATE YOUR MODULE)
USAGE FOR USER
const github = require('github-web-api');
let data = await github.user('BilalTaner')
console.log(data)
USAGE FOR DOCUMENT
const github = require('github-web-api');
let data = await github.document('BilalTaner', 'SHYNOX')
console.log(data)
EXAMPLE OUTPUT FOR USER
{
login: 'BilalTaner',
id: 66389292,
node_id: 'MDQ6VXNlcjY2Mzg5Mjky',
avatar_url: 'https://avatars2.githubusercontent.com/u/66389292?v=4',
gravatar_id: '',
url: 'https://api.github.com/users/BilalTaner',
html_url: 'https://github.com/BilalTaner',
followers_url: 'https://api.github.com/users/BilalTaner/followers',
following_url: 'https://api.github.com/users/BilalTaner/following{/other_user}',
gists_url: 'https://api.github.com/users/BilalTaner/gists{/gist_id}',
starred_url: 'https://api.github.com/users/BilalTaner/starred{/owner}{/repo}',
subscriptions_url: 'https://api.github.com/users/BilalTaner/subscriptions',
organizations_url: 'https://api.github.com/users/BilalTaner/orgs',
repos_url: 'https://api.github.com/users/BilalTaner/repos',
events_url: 'https://api.github.com/users/BilalTaner/events{/privacy}',
received_events_url: 'https://api.github.com/users/BilalTaner/received_events',
type: 'User',
site_admin: false,
name: '</shynox>',
company: null,
blog: '',
location: null,
email: null,
hireable: null,
bio: null,
twitter_username: null,
public_repos: 3,
public_gists: 0,
followers: 2,
following: 1,
created_at: '2020-06-03T20:49:40Z',
updated_at: '2020-12-23T19:15:29Z'
}
EXAMPLE OUTPUT FOR DOCUMENT
{
id: 299725691,
node_id: 'MDEwOlJlcG9zaXRvcnkyOTk3MjU2OTE=',
name: 'SHYNOX',
full_name: 'BilalTaner/SHYNOX',
private: false,
owner: {
login: 'BilalTaner',
id: 66389292,
node_id: 'MDQ6VXNlcjY2Mzg5Mjky',
avatar_url: 'https://avatars2.githubusercontent.com/u/66389292?v=4',
gravatar_id: '',
url: 'https://api.github.com/users/BilalTaner',
html_url: 'https://github.com/BilalTaner',
followers_url: 'https://api.github.com/users/BilalTaner/followers',
following_url: 'https://api.github.com/users/BilalTaner/following{/other_user}',
gists_url: 'https://api.github.com/users/BilalTaner/gists{/gist_id}',
starred_url: 'https://api.github.com/users/BilalTaner/starred{/owner}{/repo}',
subscriptions_url: 'https://api.github.com/users/BilalTaner/subscriptions',
organizations_url: 'https://api.github.com/users/BilalTaner/orgs',
repos_url: 'https://api.github.com/users/BilalTaner/repos',
events_url: 'https://api.github.com/users/BilalTaner/events{/privacy}',
received_events_url: 'https://api.github.com/users/BilalTaner/received_events',
type: 'User',
site_admin: false
},
html_url: 'https://github.com/BilalTaner/SHYNOX',
description: null,
fork: false,
url: 'https://api.github.com/repos/BilalTaner/SHYNOX',
forks_url: 'https://api.github.com/repos/BilalTaner/SHYNOX/forks',
keys_url: 'https://api.github.com/repos/BilalTaner/SHYNOX/keys{/key_id}',
collaborators_url: 'https://api.github.com/repos/BilalTaner/SHYNOX/collaborators{/collaborator}',
teams_url: 'https://api.github.com/repos/BilalTaner/SHYNOX/teams',
..... Extra more data
}
WARNING!!
If you are confronted with any problems, you can come to our discord support server below.