index

Functions

createBranch

createBranch(
  name: string,
  from: string = "",
  owner: string = "",
  repo: string = "",
  token: string = "",
)

Parameters:

Name	Type	Default
name	string
from	string	""
owner	string	""
repo	string	""
token	string	""

(source)

deleteBranch

deleteBranch(
  name: string,
  owner: string = "",
  repo: string = "",
  token: string = "",
)

Parameters:

Name	Type	Default
name	string
owner	string	""
repo	string	""
token	string	""

(source)

branchExists

branchExists(
  name: string,
  owner: string = "",
  repo: string = "",
  token: string = "",
)

Parameters:

Name	Type	Default
name	string
owner	string	""
repo	string	""
token	string	""

(source)

commitFiles

commitFiles(
  message: string,
  files: string[] = [],
  authorName: string = "",
  authorEmail: string = "",
  push: boolean = true,
  branch: string = "",
)

Parameters:

Name	Type	Default
message	string
files	string[]	[]
authorName	string	""
authorEmail	string	""
push	boolean	true
branch	string	""

(source)

openPullRequest

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

Parameters:

Name	Type	Default
title	string
body	string
head	string
base	string	""
draft	boolean	false
labels	string[]	[]
owner	string	""
repo	string	""
token	string	""

(source)

listPullRequests

listPullRequests(
  state: string = "open",
  base: string = "",
  head: string = "",
  owner: string = "",
  repo: string = "",
  token: string = "",
)

Parameters:

Name	Type	Default
state	string	"open"
base	string	""
head	string	""
owner	string	""
repo	string	""
token	string	""

(source)

commentOnPullRequest

commentOnPullRequest(
  number: number,
  body: string,
  owner: string = "",
  repo: string = "",
  token: string = "",
)

Parameters:

Name	Type	Default
number	number
body	string
owner	string	""
repo	string	""
token	string	""

(source)

addLabel

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

Parameters:

Name	Type	Default
number	number
labels	string[]
owner	string	""
repo	string	""
token	string	""

(source)

requestReview

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

Parameters:

Name	Type	Default
number	number
reviewers	string[]	[]
teamReviewers	string[]	[]
owner	string	""
repo	string	""
token	string	""

(source)

listIssues

listIssues(
  state: string = "open",
  labels: string[] = [],
  owner: string = "",
  repo: string = "",
  token: string = "",
)

Parameters:

Name	Type	Default
state	string	"open"
labels	string[]	[]
owner	string	""
repo	string	""
token	string	""

(source)

commentOnIssue

commentOnIssue(
  number: number,
  body: string,
  owner: string = "",
  repo: string = "",
  token: string = "",
)

Parameters:

Name	Type	Default
number	number
body	string
owner	string	""
repo	string	""
token	string	""

(source)

createIssue

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

Parameters:

Name	Type	Default
title	string
body	string
labels	string[]	[]
owner	string	""
repo	string	""
token	string	""

(source)

defaultBranch

defaultBranch(owner: string = "", repo: string = "", token: string = "")

Parameters:

Name	Type	Default
owner	string	""
repo	string	""
token	string	""

(source)