GitHub - Documentation

Constructor

new GitHub(optionsopt)

Create new GitHub object

Source:

GitHub.js, line 20

Parameters:

Name Type Attributes Description

options

Object

Options for this GitHub instance

Name	Type	Attributes	Description
`token`	`String`	<optional>	Initialize GitHub with auth token

Methods

_exec(key, action, paramsopt) → {Promise.<Object>}

Generic exec method for calling octokit methods

Source:

GitHub.js, line 38

Parameters:

Name	Type	Attributes	Description
`key`	`String`		Key for exec call (return object key)
`action`	`function`		Octokit action to be used
`params`	`Object`	<optional>	Additional params (sent to github)

Returns:

Type:: Promise.<Object>

Returns promise with response data

_loadPath(optionsopt)

Load a given path with options

Source:

GitHub.js, line 362

Parameters:

Name	Type	Attributes	Description
`options`	`Object`	<optional>	Load path options

auth(token)

Authorize this GitHub instance

Source:

GitHub.js, line 113

Parameters:

Name	Type	Description
`token`	`String`	GitHub access token

branch(params)

Get a single branch for a specific repo

Source:

GitHub.js, line 190

Parameters:

Name Type Description

params

Object

Parameters

Name	Type	Description
`owner`	`String`	Repo owner name
`repo`	`String`	Repo name
`branch`	`String`	Branch name

branches(params)

Get branches for a specific repo

Source:

GitHub.js, line 177

Parameters:

Name Type Description

params

Object

Parameters

Name	Type	Description
`owner`	`String`	Repo owner name
`repo`	`String`	Repo name

collaborators(params)

Get collaborators for a specific repo

Source:

GitHub.js, line 165

Parameters:

Name Type Description

params

Object

Parameters

Name	Type	Description
`owner`	`String`	Repo owner name
`repo`	`String`	Repo name

contributors(params)

Get contributors for a specific repo

Source:

GitHub.js, line 153

Parameters:

Name Type Description

params

Object

Parameters

Name	Type	Description
`owner`	`String`	Repo owner name
`repo`	`String`	Repo name

createFile(params)

Create a file on github

Source:

GitHub.js, line 256

Parameters:

Name Type Description

params

Object

Parameters

Name	Type	Description
`owner`	`String`	Repo owner name
`repo`	`String`	Repo name
`path`	`String`	Path of file being created
`message`	`String`	Message for commit on creating file
`content`	`String`	New content for created file

deleteFile(params)

Update a file on github

Source:

GitHub.js, line 275

Parameters:

Name Type Description

params

Object

Parameters

Name	Type	Description
`owner`	`String`	Repo owner name
`repo`	`String`	Repo name
`path`	`String`	Path of file being deleted
`message`	`String`	Message for commit on deleting file
`sha`	`String`	Current sha of file being deleted

files(paramsopt)

Get file(s) list or conent from github

Source:

GitHub.js, line 212

Parameters:

Name Type Attributes Description

params

Object

Parameters

Name	Type	Attributes	Default	Description
`path`	`String`	<optional>	'.'	Path to load (Default is entire repo)
`recursive`	`Boolean`	<optional>		Recursively load files (for dir path only)
`flatten`	`Boolean`	<optional>		Flatten response (for recursive only)
`tree`	`Boolean`	<optional>		Return file tree response (for dir path only)

jekyll(params)

Create a new Jekyll instance for this GitHub connection

Source:

GitHub.js, line 103

Parameters:

Name Type Description

params

Object

Parameters

Name	Type	Description
`owner`	`String`	Repo owner name
`repo`	`String`	Repo name

orgs(paramsopt)

List orgs for authenticated user

Source:

GitHub.js, line 123

Parameters:

Name	Type	Attributes	Description
`params`	`Object`	<optional>	Additional params (sent to github)

repo(params)

Get a specific repo

Source:

GitHub.js, line 141

Parameters:

Name Type Description

params

Object

Parameters

Name	Type	Description
`owner`	`String`	Repo owner name
`repo`	`String`	Repo name

repos(paramsopt)

List repos for authenticated user

Source:

GitHub.js, line 131

Parameters:

Name	Type	Attributes	Description
`params`	`Object`	<optional>	Additional params (sent to github)

updateFile(params)

Update a file on github

Source:

GitHub.js, line 237

Parameters:

Name Type Description

params

Object

Parameters

Name	Type	Description
`owner`	`String`	Repo owner name
`repo`	`String`	Repo name
`path`	`String`	Path of file being updated
`message`	`String`	Message for commit on updating file
`content`	`String`	New content for updated file
`sha`	`String`	Current sha of file being updated

upsertFiles(params)

Create or update 1 or more files on github

Source:

GitHub.js, line 293

Parameters:

Name Type Description

params

Object

Parameters

Name	Type	Description
`owner`	`String`	Repo owner name
`repo`	`String`	Repo name
`files`	`Array`	Array of file objects with base64 encoded content
`message`	`String`	Message for commit on creating file(s)

user(paramsopt)

Get the currently authenticated user

Source:

GitHub.js, line 200

Parameters:

Name	Type	Attributes	Description
`params`	`Object`	<optional>	Additional params (sent to github)