Interface: CommitParams
Properties
abortSignal
• Optional abortSignal: AbortSignal
Defined in
branch
• Optional branch: string
Default
"main"Defined in
credentials
• Optional credentials: Credentials
Defined in
description
• Optional description: string
Defined in
fetch
• Optional fetch: (input: URL | RequestInfo, init?: RequestInit) => Promise\<Response>(input: string | URL | Request, init?: RequestInit) => Promise\<Response>
Custom fetch function to use instead of the default one, for example to use a proxy or edit headers.
Type declaration
▸ (input, init?): Promise\<Response>
Parameters
| Name | Type |
|---|---|
input | URL | RequestInfo |
init? | RequestInit |
Returns
Promise\<Response>
▸ (input, init?): Promise\<Response>
Parameters
| Name | Type |
|---|---|
input | string | URL | Request |
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
Defined in
useWebWorkers
• Optional useWebWorkers: boolean | { minSize?: number ; poolSize?: number }
Whether to use web workers to compute SHA256 hashes.
We load hash-wasm from a CDN inside the web worker. Not sure how to do otherwise and still have a “clean” bundle.