GitHub encapsulates the functionality to create various API wrapper objects.
Create a new GitHub.
| 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 |
Computes the full repository name
| Name | Type | Description |
|---|---|---|
user | string | the username (or the full name) |
repo | string | the repository name, must not be passed if |
the repository's full name
Create a new Gist wrapper
| Name | Type | Attributes | Description |
|---|---|---|---|
id | number | <optional> | the id for the gist, leave undefined when creating a new gist |
Create a new Issue wrapper
| Name | Type | Description |
|---|---|---|
user | string | the user who owns the respository |
repo | string | the name of the repository |
Create a new Markdown wrapper
Create a new Organization wrapper
| Name | Type | Description |
|---|---|---|
organization | string | the name of the organization |
Create a new Project wrapper
| Name | Type | Description |
|---|---|---|
id | string | the id of the project |
Create a new RateLimit wrapper
Create a new Repository wrapper
| Name | Type | Description |
|---|---|---|
user | string | the user who owns the respository |
repo | string | the name of the repository |
create a new Team wrapper
| Name | Type | Description |
|---|---|---|
teamId | string | the name of the team |
Create a new User wrapper
| Name | Type | Attributes | Description |
|---|---|---|---|
user | string | <optional> | the name of the user to get information about leave undefined for the authenticated user |
Create a new Search wrapper
| Name | Type | Description |
|---|---|---|
query | string | the query to search for |