Class Directory

Represents a directory in GitHub

Hierarchy

Directory

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Directory(github: Octokit, repo: Repository, path: string, tree: TreeItem[]): Directory

- Defined in lib/github/github.directory.ts:25
Parameters
- github: Octokit
  
  The GitHub API
- repo: Repository
  
  The repository that instantiated the directory listing
- path: string
  
  The relative path that leads to this directory
- tree: TreeItem[]
  
  The directory listing
Returns Directory

Properties

github

github: Octokit

path

path: string

repo

repo: Repository

tree

tree: TreeItem[]

Methods

download

download(name: string): Promise<string>

- Defined in lib/github/github.directory.ts:67
Download a file from the repository

Parameters
- name: string
  
  The file to download
Returns Promise<string>

getDirectory

getDirectory(name: string): Promise<Directory>

- Defined in lib/github/github.directory.ts:54
Get a subdirectory from a path.

Parameters
- name: string
  
  The file to retrieve
Returns Promise<Directory>

getFile

getFile(name: string): TreeItem

- Defined in lib/github/github.directory.ts:45
Obtain a file's metadata from a directory

Parameters
- name: string
  
  The file to retrieve
Returns TreeItem

Generated using TypeDoc