Interface GitHubIssue

Represents a GitHub issue.

Note: GitHub's API returns pull requests as issues when listing. Check for the presence of pull_request to distinguish them.

See

https://docs.github.com/en/rest/issues/issues#get-an-issue

interface GitHubIssue {
    assignees: GitHubUser[];
    body: null | string;
    closed_at: null | string;
    closed_by?: null | GitHubUser;
    comments: number;
    created_at: string;
    html_url: string;
    id: number;
    labels: GitHubLabel[];
    locked: boolean;
    milestone: null | GitHubMilestone;
    number: number;
    pull_request?: { html_url: string; merged_at: null | string; url: string };
    state: "open" | "closed";
    title: string;
    updated_at: string;
    user: GitHubUser;
}

Properties

assignees body closed_at closed_by? comments created_at html_url id labels locked milestone number pull_request? state title updated_at user

Properties

assignees

assignees: GitHubUser[]

Users assigned to this issue

body

body: null | string

Issue body

closed_at

closed_at: null | string

ISO 8601 timestamp of closing

Optionalclosed_by

closed_by?: null | GitHubUser

User who closed the issue

comments

comments: number

Number of comments

created_at

created_at: string

ISO 8601 timestamp of creation

html_url

html_url: string

URL to the issue on GitHub

id

id: number

Unique numeric issue ID (global across GitHub)

labels

labels: GitHubLabel[]

Labels applied to this issue

locked

locked: boolean

Whether the issue is locked

milestone

milestone: null | GitHubMilestone

Milestone, if any

number

number: number

Issue number within the repository

Optionalpull_request

pull_request?: { html_url: string; merged_at: null | string; url: string }

Present when this issue is actually a pull request

state

state: "open" | "closed"

Current state

title

title: string

Issue title

updated_at

updated_at: string

ISO 8601 timestamp of last update

user

user: GitHubUser

Issue author

Settings

Member Visibility

On This Page

Properties