github-touch - versiondownload

Use github API with github-touch

  1. npm
  2. installation
  3. documentations
  4. example

Installation

you must install github-touch first via npm package and call github-touch - read this

npm i github-touch
const GithubTouch = require("github-touch")

Documentations

.searchTopic()

search any topic in github

parameters: Query

return: JSON

.searchTopic('github')

.getUser()

get a github user information

parameters: Username

return: Object

.getUser('Vins2106')

.getUserRepos()

get a user repositories

parameters: Username, ?RepoName

return: JSON, ?Object

.getUserRepos('Vins2106')

.getUserGists()

get a user gists

parameters: Username, ?GistId

return: JSON, ?Object

.getUserGists('Vins2106')

.getOrg()

get a github organization

parameters: OrganizationName

return: Object

.getOrg(bellshade')

.getOrgRepos()

get a github organization repositories

parameters: OrganizationName, ?RepoName

return: JSON, Object

.getOrgRepos('bellshade')

.getOrgTeams()

get a github organization teams

parameters: OrganizationName

return: JSON

.getOrgTeams('bellshade')

Example

example