Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "util/gitHub"

Index

Functions

addRepoWebhook

authHeaders

  • authHeaders(token: string): AxiosRequestConfig

createCommitComment

createRepo

  • createRepo(token: string, rr: GitHubRepoRef, description: string, priv: boolean): AxiosPromise

deepLink

fileContent

  • fileContent(token: string, user: string, repo: string, path: string): Promise<string | undefined>
  • Return file content, or undefined if it's not found

    Parameters

    • token: string
    • user: string
    • repo: string
    • path: string

    Returns Promise<string | undefined>

filePromise

  • filePromise(token: string, user: string, repo: string, path: string): AxiosPromise
  • Parameters

    • token: string
    • user: string
    • repo: string
    • path: string

    Returns AxiosPromise

hasFile

  • hasFile(token: string, user: string, repo: string, path: string): Promise<boolean>
  • Check whether the given file, including path, exists in the GitHub repo

    Parameters

    • token: string

      GitHub token. Don't try to auth if it's undefined or null

    • user: string
    • repo: string
    • path: string

    Returns Promise<boolean>

raiseIssue

  • raiseIssue(token: string, rr: RepoRef, issue: Issue): AxiosPromise

Generated using TypeDoc