Constructor
new GitHub(authopt, apiBaseopt)
Create a new GitHub.
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
Parameters:
| Name | Type | Description |
|---|---|---|
user |
string | the username (or the full name) |
repo |
string | the repository name, must not be passed if |
Returns:
the repository's full name
- Type
- string
getGist(idopt) → {Gist}
Create a new Gist wrapper
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
id |
number |
<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
Parameters:
| Name | Type | Description |
|---|---|---|
user |
string | the user who owns the respository |
repo |
string | the name of the repository |
Returns:
- Type
- Issue
getMarkdown() → {Markdown}
Create a new Markdown wrapper
Returns:
- Type
- Markdown
getOrganization(organization) → {Organization}
Create a new Organization wrapper
Parameters:
| Name | Type | Description |
|---|---|---|
organization |
string | the name of the organization |
Returns:
- Type
- Organization
getProject(id) → {Markdown}
Create a new Project wrapper
Parameters:
| Name | Type | Description |
|---|---|---|
id |
string | the id of the project |
Returns:
- Type
- Markdown
getRateLimit() → {RateLimit}
Create a new RateLimit wrapper
Returns:
- Type
- RateLimit
getRepo(user, repo) → {Repository}
Create a new Repository wrapper
Parameters:
| Name | Type | Description |
|---|---|---|
user |
string | the user who owns the respository |
repo |
string | the name of the repository |
Returns:
- Type
- Repository
getTeam(teamId) → {team}
create a new Team wrapper
Parameters:
| Name | Type | Description |
|---|---|---|
teamId |
string | the name of the team |
Returns:
- Type
- team
getUser(useropt) → {User}
Create a new User wrapper
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
search(query) → {Search}
Create a new Search wrapper
Parameters:
| Name | Type | Description |
|---|---|---|
query |
string | the query to search for |
Returns:
- Type
- Search