2020-08-12 01:39:53 +00:00
|
|
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
|
|
|
|
|
|
|
|
[Home](./index.md) > [cautious-journey](./cautious-journey.md) > [GithubRemote](./cautious-journey.githubremote.md)
|
|
|
|
|
|
|
|
|
|
## GithubRemote class
|
|
|
|
|
|
|
|
|
|
Github/Octokit API implementation of the `Remote` contract.
|
|
|
|
|
|
|
|
|
|
<b>Signature:</b>
|
|
|
|
|
|
|
|
|
|
```typescript
|
|
|
|
|
export declare class GithubRemote implements Remote
|
|
|
|
|
```
|
|
|
|
|
<b>Implements:</b> [Remote](./cautious-journey.remote.md)
|
|
|
|
|
|
2020-08-12 05:12:57 +00:00
|
|
|
## Constructors
|
|
|
|
|
|
|
|
|
|
| Constructor | Modifiers | Description |
|
|
|
|
|
| --- | --- | --- |
|
|
|
|
|
| [(constructor)(options)](./cautious-journey.githubremote._constructor_.md) | | Constructs a new instance of the <code>GithubRemote</code> class |
|
|
|
|
|
|
2020-08-12 23:21:35 +00:00
|
|
|
## Properties
|
|
|
|
|
|
|
|
|
|
| Property | Modifiers | Type | Description |
|
|
|
|
|
| --- | --- | --- | --- |
|
|
|
|
|
| [options](./cautious-journey.githubremote.options.md) | | [RemoteOptions](./cautious-journey.remoteoptions.md) | |
|
2020-08-14 00:37:30 +00:00
|
|
|
| [request](./cautious-journey.githubremote.request.md) | | Octokit | Github API client. Will not be set for a dry run. |
|
2020-08-14 02:59:53 +00:00
|
|
|
| [writeCapable](./cautious-journey.githubremote.writecapable.md) | | boolean | |
|
|
|
|
|
| [writeRequest](./cautious-journey.githubremote.writerequest.md) | | Octokit | |
|
2020-08-12 23:21:35 +00:00
|
|
|
|
2020-08-12 01:39:53 +00:00
|
|
|
## Methods
|
|
|
|
|
|
|
|
|
|
| Method | Modifiers | Description |
|
|
|
|
|
| --- | --- | --- |
|
2020-08-12 23:21:35 +00:00
|
|
|
| [connect()](./cautious-journey.githubremote.connect.md) | | |
|
2020-08-16 22:07:07 +00:00
|
|
|
| [createComment(options)](./cautious-journey.githubremote.createcomment.md) | | |
|
2020-08-13 23:44:13 +00:00
|
|
|
| [createLabel(options)](./cautious-journey.githubremote.createlabel.md) | | |
|
|
|
|
|
| [deleteLabel(options)](./cautious-journey.githubremote.deletelabel.md) | | |
|
2020-08-16 22:07:07 +00:00
|
|
|
| [formatBody(options)](./cautious-journey.githubremote.formatbody.md) | | |
|
2020-08-12 01:39:53 +00:00
|
|
|
| [getIssue()](./cautious-journey.githubremote.getissue.md) | | |
|
|
|
|
|
| [getLabel()](./cautious-journey.githubremote.getlabel.md) | | |
|
2020-08-12 23:21:35 +00:00
|
|
|
| [listIssues(options)](./cautious-journey.githubremote.listissues.md) | | |
|
|
|
|
|
| [listLabels(options)](./cautious-journey.githubremote.listlabels.md) | | |
|
|
|
|
|
| [splitProject(project)](./cautious-journey.githubremote.splitproject.md) | | |
|
2020-08-15 04:40:56 +00:00
|
|
|
| [updateIssue(options)](./cautious-journey.githubremote.updateissue.md) | | |
|
2020-08-13 01:40:28 +00:00
|
|
|
| [updateLabel(options)](./cautious-journey.githubremote.updatelabel.md) | | |
|
2020-08-12 01:39:53 +00:00
|
|
|
|
