Issue

Issue wraps the functionality to get issues for repositories

Constructor

new Issue(repository, authopt, apiBaseopt)

Create a new Issue

Parameters:

Name	Type	Attributes	Default	Description
`repository`	string			the full name of the repository (`:user/:repo`) to get issues for
`auth`	Requestable.auth	<optional>		information required to authenticate to Github
`apiBase`	string	<optional>	https://api.github.com	the base Github API URL

Source:

Issue.js,line 13

Methods

createIssue(issueData, cbopt) → {Promise}

Create a new issue

Parameters:

Name	Type	Attributes	Description
`issueData`	Object		the issue to create
`cb`	Requestable.callback	<optional>	will receive the created issue

Source:

Issue.js,line 32

See:

https://developer.github.com/v3/issues/#create-an-issue

Returns:

the promise for the http request

Type: Promise

createIssueComment(issue, comment, cbopt) → {Promise}

Comment on an issue

Parameters:

Name	Type	Attributes	Description
`issue`	number		the id of the issue to comment on
`comment`	string		the comment to add
`cb`	Requestable.callback	<optional>	will receive the created comment

Source:

Issue.js,line 88

See:

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

Returns:

the promise for the http request

Type: Promise

createLabel(labelData, cbopt) → {Promise}

Create a new label

Parameters:

Name	Type	Attributes	Description
`labelData`	Object		the label definition
`cb`	Requestable.callback	<optional>	will receive the object representing the label

Source:

Issue.js,line 201

See:

https://developer.github.com/v3/issues/labels/#create-a-label

Returns:

the promise for the http request

Type: Promise

createMilestone(milestoneData, cbopt) → {Promise}

Create a new milestone

Parameters:

Name	Type	Attributes	Description
`milestoneData`	Object		the milestone definition
`cb`	Requestable.callback	<optional>	will receive the milestone

Source:

Issue.js,line 167

See:

https://developer.github.com/v3/issues/milestones/#create-a-milestone

Returns:

the promise for the http request

Type: Promise

deleteIssueComment(id, cbopt) → {Promise}

Delete a comment on an issue

Parameters:

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

Source:

Issue.js,line 111

See:

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

Returns:

the promise for the http request

Type: Promise

deleteLabel(label, cbopt) → {Promise}

Delete a label

Parameters:

Name	Type	Attributes	Description
`label`	string		the name of the label to delete
`cb`	Requestable.callback	<optional>	will receive the status

Source:

Issue.js,line 246

See:

https://developer.github.com/v3/issues/labels/#delete-a-label

Returns:

the promise for the http request

Type: Promise

deleteMilestone(milestone, cbopt) → {Promise}

Delete a milestone (this is distinct from closing a milestone)

Parameters:

Name	Type	Attributes	Description
`milestone`	string		the id of the milestone to delete
`cb`	Requestable.callback	<optional>	will receive the status

Source:

Issue.js,line 190

See:

https://developer.github.com/v3/issues/milestones/#delete-a-milestone

Returns:

the promise for the http request

Type: Promise

editIssue(issue, issueData, cbopt) → {Promise}

Edit an issue

Parameters:

Name	Type	Attributes	Description
`issue`	number		the issue number to edit
`issueData`	Object		the new issue data
`cb`	Requestable.callback	<optional>	will receive the modified issue

Source:

Issue.js,line 123

See:

https://developer.github.com/v3/issues/#edit-an-issue

Returns:

the promise for the http request

Type: Promise

editIssueComment(id, comment, cbopt) → {Promise}

Edit a comment on an issue

Parameters:

Name	Type	Attributes	Description
`id`	number		the comment id to edit
`comment`	string		the comment to edit
`cb`	Requestable.callback	<optional>	will receive the edited comment

Source:

Issue.js,line 100

See:

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

Returns:

the promise for the http request

Type: Promise

editLabel(label, labelData, cbopt) → {Promise}

Edit a label

Parameters:

Name	Type	Attributes	Description
`label`	string		the name of the label to edit
`labelData`	Object		the updates to make to the label
`cb`	Requestable.callback	<optional>	will receive the updated label

Source:

Issue.js,line 235

See:

https://developer.github.com/v3/issues/labels/#update-a-label

Returns:

the promise for the http request

Type: Promise

editMilestone(milestone, milestoneData, cbopt) → {Promise}

Edit a milestone

Parameters:

Name	Type	Attributes	Description
`milestone`	string		the id of the milestone to edit
`milestoneData`	Object		the updates to make to the milestone
`cb`	Requestable.callback	<optional>	will receive the updated milestone

Source:

Issue.js,line 179

See:

https://developer.github.com/v3/issues/milestones/#update-a-milestone

Returns:

the promise for the http request

Type: Promise

getIssue(issue, cbopt) → {Promise}

Get a particular issue

Parameters:

Name	Type	Attributes	Description
`issue`	number		the issue number to fetch
`cb`	Requestable.callback	<optional>	will receive the issue

Source:

Issue.js,line 134

See:

https://developer.github.com/v3/issues/#get-a-single-issue

Returns:

the promise for the http request

Type: Promise

getIssueComment(id, cbopt) → {Promise}

Get a single comment on an issue

Parameters:

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

Source:

Issue.js,line 76

See:

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

Returns:

the promise for the http request

Type: Promise

getLabel(label, cbopt) → {Promise}

Get a label

Parameters:

Name	Type	Attributes	Description
`label`	string		the name of the label to fetch
`cb`	Requestable.callback	<optional>	will receive the label

Source:

Issue.js,line 223

See:

https://developer.github.com/v3/issues/labels/#get-a-single-label

Returns:

the promise for the http request

Type: Promise

getMilestone(milestone, cbopt) → {Promise}

Get a milestone

Parameters:

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

Source:

Issue.js,line 156

See:

https://developer.github.com/v3/issues/milestones/#get-a-single-milestone

Returns:

the promise for the http request

Type: Promise

listIssueComments(issue, cbopt) → {Promise}

List comments on an issue

Parameters:

Name	Type	Attributes	Description
`issue`	number		the id of the issue to get comments from
`cb`	Requestable.callback	<optional>	will receive the comments

Source:

Issue.js,line 65

See:

https://developer.github.com/v3/issues/comments/#list-comments-on-an-issue

Returns:

the promise for the http request

Type: Promise

listIssueEvents(issue, cbopt) → {Promise}

List the events for an issue

Parameters:

Name	Type	Attributes	Description
`issue`	number		the issue to get events for
`cb`	Requestable.callback	<optional>	will receive the list of events

Source:

Issue.js,line 54

See:

https://developer.github.com/v3/issues/events/#list-events-for-an-issue

Returns:

the promise for the http request

Type: Promise

listIssues(options, cbopt) → {Promise}

List the issues for the repository

Parameters:

Name	Type	Attributes	Description
`options`	Object		filtering options
`cb`	Requestable.callback	<optional>	will receive the array of issues

Source:

Issue.js,line 43

See:

https://developer.github.com/v3/issues/#list-issues-for-a-repository

Returns:

the promise for the http request

Type: Promise

listLabels(options, cbopt) → {Promise}

List the labels for the repository

Parameters:

Name	Type	Attributes	Description
`options`	Object		filtering options
`cb`	Requestable.callback	<optional>	will receive the array of labels

Source:

Issue.js,line 212

See:

https://developer.github.com/v3/issues/labels/#list-all-labels-for-this-repository

Returns:

the promise for the http request

Type: Promise

listMilestones(options, cbopt) → {Promise}

List the milestones for the repository

Parameters:

Name	Type	Attributes	Description
`options`	Object		filtering options
`cb`	Requestable.callback	<optional>	will receive the array of milestones

Source:

Issue.js,line 145

See:

https://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository

Returns:

the promise for the http request

Type: Promise

Movatterモバイル変換

Issue

Constructor

new Issue(repository, authopt, apiBaseopt)

Parameters:

Methods

createIssue(issueData, cbopt) → {Promise}

Parameters:

Returns:

createIssueComment(issue, comment, cbopt) → {Promise}

Parameters:

Returns:

createLabel(labelData, cbopt) → {Promise}

Parameters:

Returns:

createMilestone(milestoneData, cbopt) → {Promise}

Parameters:

Returns:

deleteIssueComment(id, cbopt) → {Promise}

Parameters:

Returns:

deleteLabel(label, cbopt) → {Promise}

Parameters:

Returns:

deleteMilestone(milestone, cbopt) → {Promise}

Parameters:

Returns:

editIssue(issue, issueData, cbopt) → {Promise}

Parameters:

Returns:

editIssueComment(id, comment, cbopt) → {Promise}

Parameters:

Returns:

editLabel(label, labelData, cbopt) → {Promise}

Parameters:

Returns:

editMilestone(milestone, milestoneData, cbopt) → {Promise}

Parameters:

Returns:

getIssue(issue, cbopt) → {Promise}

Parameters:

Returns:

getIssueComment(id, cbopt) → {Promise}

Parameters:

Returns:

getLabel(label, cbopt) → {Promise}

Parameters:

Returns:

getMilestone(milestone, cbopt) → {Promise}

Parameters:

Returns:

listIssueComments(issue, cbopt) → {Promise}

Parameters:

Returns:

listIssueEvents(issue, cbopt) → {Promise}

Parameters:

Returns:

listIssues(options, cbopt) → {Promise}

Parameters:

Returns:

listLabels(options, cbopt) → {Promise}

Parameters:

Returns:

listMilestones(options, cbopt) → {Promise}

Parameters:

Returns: