Issue

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:

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:
See:
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:
See:
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:
See:
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:
See:
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:
See:
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:
See:
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:
See:
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:
See:
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:
See:
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:
See:
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:
See:
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:
See:
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:
See:
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:
See:
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:
See:
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:
See:
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:
See:
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:
See:
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:
See:
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:
See:
Returns:
  • the promise for the http request
Type
Promise