Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Repository

Represents a Repository on GitHub to pull data from

Hierarchy

  • Repository

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Repository(token: string, owner: string, name: string, branch?: string): Repository

  • Parameters

    • token: string

      Your GitHub Application Token

    • owner: string
    • name: string
    • Default value branch: string = "master"

      the branch to pull data from

    Returns Repository

Properties

branch

branch: string

github

github: Octokit

name

name: string

owner

owner: string

repoString

repoString: string

token

token: string

Methods

getDirectory

  • getDirectory(path: string): Promise<Directory>

  • Gets the directory tree for the specific git repository in GitHub

    Parameters

    • path: string

      the path of where the data is

    Returns Promise<Directory>

Generated using TypeDoc