Skip to content

index

Functions

createBranch

ts
createBranch(name: string, from: string, owner: string, repo: string, token: string)

Parameters:

NameTypeDefault
namestring
fromstring""
ownerstring""
repostring""
tokenstring""

(source)

deleteBranch

ts
deleteBranch(name: string, owner: string, repo: string, token: string)

Parameters:

NameTypeDefault
namestring
ownerstring""
repostring""
tokenstring""

(source)

branchExists

ts
branchExists(name: string, owner: string, repo: string, token: string)

Parameters:

NameTypeDefault
namestring
ownerstring""
repostring""
tokenstring""

(source)

commitFiles

ts
commitFiles(message: string, files: string[], authorName: string, authorEmail: string, push: boolean, branch: string)

Parameters:

NameTypeDefault
messagestring
filesstring[][]
authorNamestring""
authorEmailstring""
pushbooleantrue
branchstring""

(source)

openPullRequest

ts
openPullRequest(title: string, body: string, head: string, base: string, draft: boolean, labels: string[], owner: string, repo: string, token: string)

Parameters:

NameTypeDefault
titlestring
bodystring
headstring
basestring""
draftbooleanfalse
labelsstring[][]
ownerstring""
repostring""
tokenstring""

(source)

listPullRequests

ts
listPullRequests(state: string, base: string, head: string, owner: string, repo: string, token: string)

Parameters:

NameTypeDefault
statestring"open"
basestring""
headstring""
ownerstring""
repostring""
tokenstring""

(source)

commentOnPullRequest

ts
commentOnPullRequest(number: number, body: string, owner: string, repo: string, token: string)

Parameters:

NameTypeDefault
numbernumber
bodystring
ownerstring""
repostring""
tokenstring""

(source)

addLabel

ts
addLabel(number: number, labels: string[], owner: string, repo: string, token: string)

Parameters:

NameTypeDefault
numbernumber
labelsstring[]
ownerstring""
repostring""
tokenstring""

(source)

requestReview

ts
requestReview(number: number, reviewers: string[], teamReviewers: string[], owner: string, repo: string, token: string)

Parameters:

NameTypeDefault
numbernumber
reviewersstring[][]
teamReviewersstring[][]
ownerstring""
repostring""
tokenstring""

(source)

listIssues

ts
listIssues(state: string, labels: string[], owner: string, repo: string, token: string)

Parameters:

NameTypeDefault
statestring"open"
labelsstring[][]
ownerstring""
repostring""
tokenstring""

(source)

commentOnIssue

ts
commentOnIssue(number: number, body: string, owner: string, repo: string, token: string)

Parameters:

NameTypeDefault
numbernumber
bodystring
ownerstring""
repostring""
tokenstring""

(source)

createIssue

ts
createIssue(title: string, body: string, labels: string[], owner: string, repo: string, token: string)

Parameters:

NameTypeDefault
titlestring
bodystring
labelsstring[][]
ownerstring""
repostring""
tokenstring""

(source)

defaultBranch

ts
defaultBranch(owner: string, repo: string, token: string)

Parameters:

NameTypeDefault
ownerstring""
repostring""
tokenstring""

(source)