Constructors
constructor
- new Github(token: string, owner: string, repo: string): Github
-
Parameters
-
token: string
-
owner: string
-
repo: string
Methods
comment
- comment(issue_number: number, body: string): Promise<void>
-
Parameters
-
issue_number: number
-
body: string
Returns Promise<void>
create_issue
- create_issue(issue: string): Promise<any>
-
Parameters
Returns Promise<any>
get_assignees
- get_assignees(): Promise<any[]>
-
Returns Promise<any[]>
- list of github login names for the assignees
get_file
- get_file(path: string, file_name: string): Promise<string>
-
Parameters
-
path: string
-
file_name: string
Returns Promise<string>
- the raw content of the file
get_json
- get_json(path: string): Promise<any>
-
Parameters
Returns Promise<any>
- JSON content turned into an object
get_listing
- get_listing(path: string, page_size?: number): Promise<any>
-
Parameters
-
path: string
-
Default value page_size: number = null
Returns Promise<any>
- Github API object for the listing
update
- update(path: string, message: string, new_content: any, sha?: string): Promise<void>
-
Parameters
-
path: string
-
message: string
-
new_content: any
-
Default value sha: string = undefined
Returns Promise<void>
Wrapper around a the Github API using the more generic octocat library.