Gist

A Gist can retrieve and modify gists.

Constructor

new Gist(id, authopt, apiBaseopt)

Create a Gist.

Parameters:

Name	Type	Attributes	Default	Description
`id`	string			the id of the gist (not required when creating a gist)
`auth`	Requestable.auth	<optional>		information required to authenticate to Github
`apiBase`	string	<optional>	https://api.github.com	the base Github API URL

Source:

Gist.js,line 13

Methods

create(gist, cbopt) → {Promise}

Create a new gist.

Parameters:

Name	Type	Attributes	Description
`gist`	Object		the data for the new gist
`cb`	Requestable.callback	<optional>	will receive the new gist upon creation

Source:

Gist.js,line 42

See:

https://developer.github.com/v3/gists/#create-a-gist

Returns:

the Promise for the http request

Type: Promise

createComment(comment, cbopt) → {Promise}

Comment on a gist

Parameters:

Name	Type	Attributes	Description
`comment`	string		the comment to add
`cb`	Requestable.callback	<optional>	the function that receives the API result

Source:

Gist.js,line 160

See:

https://developer.github.com/v3/gists/comments/#create-a-comment

Returns:

the Promise for the http request

Type: Promise

delete(cbopt) → {Promise}

Delete a gist.

Parameters:

Name	Type	Attributes	Description
`cb`	Requestable.callback	<optional>	will receive true if the request succeeds

Source:

Gist.js,line 56

See:

https://developer.github.com/v3/gists/#delete-a-gist

Returns:

the Promise for the http request

Type: Promise

deleteComment(comment, cbopt) → {Promise}

Delete a comment on the gist.

Parameters:

Name	Type	Attributes	Description
`comment`	number		the id of the comment
`cb`	Requestable.callback	<optional>	will receive true if the request succeeds

Source:

Gist.js,line 183

See:

https://developer.github.com/v3/gists/comments/#delete-a-comment

Returns:

the Promise for the http request

Type: Promise

editComment(comment, body, cbopt) → {Promise}

Edit a comment on the gist

Parameters:

Name	Type	Attributes	Description
`comment`	number		the id of the comment
`body`	string		the new comment
`cb`	Requestable.callback	<optional>	will receive the modified comment

Source:

Gist.js,line 172

See:

https://developer.github.com/v3/gists/comments/#edit-a-comment

Returns:

the promise for the http request

Type: Promise

fork(cbopt) → {Promise}

Fork a gist.

Parameters:

Name	Type	Attributes	Description
`cb`	Requestable.callback	<optional>	the function that will receive the gist

Source:

Gist.js,line 66

See:

https://developer.github.com/v3/gists/#fork-a-gist

Returns:

the Promise for the http request

Type: Promise

getComment(comment, cbopt) → {Promise}

Fetch one of the gist's comments

Parameters:

Name	Type	Attributes	Description
`comment`	number		the id of the comment
`cb`	Requestable.callback	<optional>	will receive the comment

Source:

Gist.js,line 149

See:

https://developer.github.com/v3/gists/comments/#get-a-single-comment

Returns:

the Promise for the http request

Type: Promise

getRevision(revision, cbopt) → {Promise}

Fetch one of the gist's revision.

Parameters:

Name	Type	Attributes	Description
`revision`	string		the id of the revision
`cb`	Requestable.callback	<optional>	will receive the revision

Source:

Gist.js,line 128

See:

https://developer.github.com/v3/gists/#get-a-specific-revision-of-a-gist

Returns:

the Promise for the http request

Type: Promise

isStarred(cbopt) → {Promise}

Check if a gist is starred by the user.

Parameters:

Name	Type	Attributes	Description
`cb`	Requestable.callback	<optional>	will receive true if the gist is starred and false if the gist is not starred

Source:

Gist.js,line 107

See:

https://developer.github.com/v3/gists/#check-if-a-gist-is-starred

Returns:

the Promise for the http request

Type: Promise

listComments(cbopt) → {Promise}

List the gist's comments

Parameters:

Name	Type	Attributes	Description
`cb`	Requestable.callback	<optional>	will receive the array of comments

Source:

Gist.js,line 138

See:

https://developer.github.com/v3/gists/comments/#list-comments-on-a-gist

Returns:

the promise for the http request

Type: Promise

listCommits(cbopt) → {Promise}

List the gist's commits

Parameters:

Name	Type	Attributes	Description
`cb`	Requestable.callback	<optional>	will receive the array of commits

Source:

Gist.js,line 117

See:

https://developer.github.com/v3/gists/#list-gist-commits

Returns:

the Promise for the http request

Type: Promise

read(cbopt) → {Promise}

Fetch a gist.

Parameters:

Name	Type	Attributes	Description
`cb`	Requestable.callback	<optional>	will receive the gist

Source:

Gist.js,line 31

See:

https://developer.github.com/v3/gists/#get-a-single-gist

Returns:

the Promise for the http request

Type: Promise

star(cbopt) → {Promise}

Star a gist.

Parameters:

Name	Type	Attributes	Description
`cb`	Requestable.callback	<optional>	will receive true if the request is successful

Source:

Gist.js,line 87

See:

https://developer.github.com/v3/gists/#star-a-gist

Returns:

the Promise for the http request

Type: Promise

unstar(cbopt) → {Promise}

Unstar a gist.

Parameters:

Name	Type	Attributes	Description
`cb`	Requestable.callback	<optional>	will receive true if the request is successful

Source:

Gist.js,line 97

See:

https://developer.github.com/v3/gists/#unstar-a-gist

Returns:

the Promise for the http request

Type: Promise

update(gist, cbopt) → {Promise}

Update a gist.

Parameters:

Name	Type	Attributes	Description
`gist`	Object		the new data for the gist
`cb`	Requestable.callback	<optional>	the function that receives the API result

Source:

Gist.js,line 77

See:

https://developer.github.com/v3/gists/#edit-a-gist

Returns:

the Promise for the http request

Type: Promise

Movatterモバイル変換

Gist

Constructor

new Gist(id, authopt, apiBaseopt)

Parameters:

Methods

create(gist, cbopt) → {Promise}

Parameters:

Returns:

createComment(comment, cbopt) → {Promise}

Parameters:

Returns:

delete(cbopt) → {Promise}

Parameters:

Returns:

deleteComment(comment, cbopt) → {Promise}

Parameters:

Returns:

editComment(comment, body, cbopt) → {Promise}

Parameters:

Returns:

fork(cbopt) → {Promise}

Parameters:

Returns:

getComment(comment, cbopt) → {Promise}

Parameters:

Returns:

getRevision(revision, cbopt) → {Promise}

Parameters:

Returns:

isStarred(cbopt) → {Promise}

Parameters:

Returns:

listComments(cbopt) → {Promise}

Parameters:

Returns:

listCommits(cbopt) → {Promise}

Parameters:

Returns:

read(cbopt) → {Promise}

Parameters:

Returns:

star(cbopt) → {Promise}

Parameters:

Returns:

unstar(cbopt) → {Promise}

Parameters:

Returns:

update(gist, cbopt) → {Promise}

Parameters:

Returns: