Module "core/util/github/ghub"

Index

Interfaces

Type aliases

State

Functions

Type aliases

State

State: "error" | "failure" | "pending" | "success"

Functions

authHeaders

authHeaders(token: string): AxiosRequestConfig

- Defined in lib/core/util/github/ghub.ts:183
Parameters
- token: string
Returns AxiosRequestConfig

createRelease

createRelease(creds: string | ProjectOperationCredentials, rr: GitHubRepoRef, release: Release): AxiosPromise

- Defined in lib/core/util/github/ghub.ts:147
Parameters
- creds: string | ProjectOperationCredentials
- rr: GitHubRepoRef
- release: Release
Returns AxiosPromise

createStatus

createStatus(creds: string | ProjectOperationCredentials, rr: GitHubRepoRef, inputStatus: Status): AxiosPromise

- Defined in lib/core/util/github/ghub.ts:53
Create a GitHub status

Parameters
- creds: string | ProjectOperationCredentials
- rr: GitHubRepoRef
- inputStatus: Status
Returns AxiosPromise

createTag

createTag(creds: string | ProjectOperationCredentials, rr: GitHubRepoRef, tag: Tag): AxiosPromise

- Defined in lib/core/util/github/ghub.ts:105
Parameters
- creds: string | ProjectOperationCredentials
- rr: GitHubRepoRef
- tag: Tag
Returns AxiosPromise

createTagReference

createTagReference(creds: string | ProjectOperationCredentials, rr: GitHubRepoRef, tag: Tag): AxiosPromise

- Defined in lib/core/util/github/ghub.ts:115
Parameters
- creds: string | ProjectOperationCredentials
- rr: GitHubRepoRef
- tag: Tag
Returns AxiosPromise

deleteRepository

deleteRepository(creds: string | ProjectOperationCredentials, rr: GitHubRepoRef): AxiosPromise

- Defined in lib/core/util/github/ghub.ts:125
Parameters
- creds: string | ProjectOperationCredentials
- rr: GitHubRepoRef
Returns AxiosPromise

ensureValidUrl

ensureValidUrl(inputStatus: Status): Status

- Defined in lib/core/util/github/ghub.ts:75
Parameters
- inputStatus: Status
Returns Status

isPublicRepo

isPublicRepo(creds: string | ProjectOperationCredentials, rr: GitHubRepoRef): Promise<boolean>

- Defined in lib/core/util/github/ghub.ts:200
Parameters
- creds: string | ProjectOperationCredentials
- rr: GitHubRepoRef
Returns Promise<boolean>

listCommitsBetween

listCommitsBetween(creds: string | ProjectOperationCredentials, rr: GitHubRepoRef, startSha: string, endSha: string): Promise<GitHubCommitsBetween>

- Defined in lib/core/util/github/ghub.ts:173
List commits between these shas

Parameters
- creds: string | ProjectOperationCredentials
- rr: GitHubRepoRef
- startSha: string
- endSha: string
Returns Promise<GitHubCommitsBetween>

listTopics

listTopics(creds: string | ProjectOperationCredentials, rr: RemoteRepoRef): Promise<string[]>

- Defined in lib/core/util/github/ghub.ts:226
Parameters
- creds: string | ProjectOperationCredentials
- rr: RemoteRepoRef
Returns Promise<string[]>

tipOfDefaultBranch

tipOfDefaultBranch(creds: string | ProjectOperationCredentials, rr: GitHubRepoRef): Promise<string>

- Defined in lib/core/util/github/ghub.ts:192
Parameters
- creds: string | ProjectOperationCredentials
- rr: GitHubRepoRef
Returns Promise<string>

updateIssue

updateIssue(creds: string | ProjectOperationCredentials, rr: RemoteRepoRef, issueNumber: number, issue: Issue): AxiosPromise

- Defined in lib/core/util/github/ghub.ts:216
Parameters
- creds: string | ProjectOperationCredentials
- rr: RemoteRepoRef
- issueNumber: number
- issue: Issue
Returns AxiosPromise

Generated using TypeDoc