github.updatepullrequestprops
Home > @runlightyear/github > UpdatePullRequestProps
UpdatePullRequestProps interface
This is a description of these props
Signature:interface UpdatePullRequestProps
Required Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| owner | string | The account owner of the repository. The name is not case sensitive. | |
| pullNumber | number | The number that identifies the pull request. | |
| repo | string | The name of the repository. The name is not case sensitive. |
Optional Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| base? | string | The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository. | |
| body? | string | The contents of the pull request. | |
| maintainerCanModify? | boolean | Indicates whether maintainers can modify the pull request. | |
| state? | "open" | "closed" | State of this Pull Request. Either open or closed. | |
| title? | string | The title of the pull request. |