Interface: CommitParams
Properties
branch
• Optional branch: string
Default
“main”
Defined in
credentials
• credentials: Credentials
Defined in
description
• Optional description: string
Defined in
fetch
• Optional fetch: (input: URL | RequestInfo, init?: RequestInit) => Promise<Response>
Type declaration
▸ (input, init?): Promise<Response>
Custom fetch function to use instead of the default one, for example to use a proxy or edit headers.
Parameters
| Name | Type |
|---|---|
input |
URL | RequestInfo |
init? |
RequestInit |
Returns
Promise<Response>
Defined in
hubUrl
• Optional hubUrl: string
Defined in
isPullRequest
• Optional isPullRequest: boolean
Defined in
operations
• operations: CommitOperation[]
Defined in
parentCommit
• Optional parentCommit: string
Parent commit. Optional
- When opening a PR: will use parentCommit as the parent commit
- When committing on a branch: Will make sure that there were no intermediate commits
Defined in
repo
• repo: RepoDesignation
Defined in
title
• title: string