github.comparetwocommitsprops
Home > @runlightyear/github > CompareTwoCommitsProps
CompareTwoCommitsProps interface
Signature:interface CompareTwoCommitsProps
Required Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| basehead | string | The base branch and head branch to compare. This parameter expects the format BASE...HEAD. Both must be branch names in repo. To compare with a branch that exists in a different repository in the same network as repo, the basehead parameter expects the format USERNAME:BASE...USERNAME:HEAD. | |
| owner | string | The account owner of the repository. The name is not case sensitive. | |
| repo | string | The name of the repository. The name is not case sensitive. |
Optional Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| page? | number | Page number of the results to fetch. Default: 1 | |
| perPage? | number | The number of results per page (max 100). Default: 30 |