GitHub

GitHub

GitHub encapsulates the functionality to create various API wrapper objects.

Constructor

new GitHub(authopt, apiBaseopt)

Create a new GitHub.

Source:
Parameters:
Name Type Attributes Default Description
auth Requestable.auth <optional>

the credentials to authenticate to Github. If auth is not provided requests will be made unauthenticated
apiBase string <optional>
 https://api.github.com

the base Github API URL

Methods

_getFullName(user, repo) → {string}

Computes the full repository name

Source:
Parameters:
Name Type Description
user string

the username (or the full name)
repo string

the repository name, must not be passed if user is the full name
Returns:
Type:
string

the repository's full name

getGist(idopt) → {Gist}

Create a new Gist wrapper

Source:
Parameters:
Name Type Attributes Description
id string <optional>

the id for the gist, leave undefined when creating a new gist
Returns:
Type:
Gist

getIssues(user, repo) → {Issue}

Create a new Issue wrapper

Source:
Parameters:
Name Type Description
user string

the user who owns the repository
repo string

the name of the repository
Returns:
Type:
Issue

getMarkdown() → {Markdown}

Create a new Markdown wrapper

Source:
Returns:
Type:
Markdown

getOrganization(organization) → {Organization}

Create a new Organization wrapper

Source:
Parameters:
Name Type Description
organization string

the name of the organization
Returns:
Type:
Organization

getProject(id) → {Project}

Create a new Project wrapper

Source:
Parameters:
Name Type Description
id string

the id of the project
Returns:
Type:
Project

getRateLimit() → {RateLimit}

Create a new RateLimit wrapper

Source:
Returns:
Type:
RateLimit

getRepo(user, repo) → {Repository}

Create a new Repository wrapper

Source:
Parameters:
Name Type Description
user string

the user who owns the repository
repo string

the name of the repository
Returns:
Type:
Repository

getTeam(teamId) → {team}

create a new Team wrapper

Source:
Parameters:
Name Type Description
teamId string

the name of the team
Returns:
Type:
team

getUser(useropt) → {User}

Create a new User wrapper

Source:
Parameters:
Name Type Attributes Description
user string <optional>

the name of the user to get information about leave undefined for the authenticated user
Returns:
Type:
User

Create a new Search wrapper

Source:
Parameters:
Name Type Description
query string

the query to search for
Returns:
Type:
Search