A User allows scoping of API requests to a particular Github user.
Create a User.
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
username | string | <optional> | the user to use for user-scoped queries | |
auth | Requestable.auth | <optional> | information required to authenticate to Github | |
apiBase | string | <optional> | https://api.github.com | the base Github API URL |
Create a new repository for the currently authenticated user
| Name | Type | Attributes | Description |
|---|---|---|---|
options | object | the repository definition | |
cb | Requestable.callback | <optional> | will receive the API response |
Have the authenticated user follow this user
| Name | Type | Attributes | Description |
|---|---|---|---|
username | string | the user to follow | |
cb | Requestable.callback | <optional> | will receive true if the request succeeds |
List email addresses for a user
| Name | Type | Attributes | Description |
|---|---|---|---|
cb | Requestable.callback | <optional> | will receive the list of emails |
Show the user's profile
| Name | Type | Attributes | Description |
|---|---|---|---|
cb | Requestable.callback | <optional> | will receive the user's information |
List the user's gists
| Name | Type | Attributes | Description |
|---|---|---|---|
cb | Requestable.callback | <optional> | will receive the list of gists |
List the user's notifications
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
options | Object | <optional> | {} | any options to refine the search |
cb | Requestable.callback | <optional> | will receive the list of repositories |
List the orgs that the user belongs to
| Name | Type | Attributes | Description |
|---|---|---|---|
cb | Requestable.callback | <optional> | will receive the list of organizations |
List the user's repositories
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
options | Object | <optional> | {} | any options to refine the search |
cb | Requestable.callback | <optional> | will receive the list of repositories |
Gets the list of starred repositories for the user
| Name | Type | Attributes | Description |
|---|---|---|---|
cb | Requestable.callback | <optional> | will receive the list of starred repositories |
Have the currently authenticated user unfollow this user
| Name | Type | Attributes | Description |
|---|---|---|---|
username | string | the user to unfollow | |
cb | Requestable.callback | <optional> | receives true if the request succeeds |