Interface GitHubPullRequest

Represents a GitHub pull request.

See

https://docs.github.com/en/rest/pulls/pulls#get-a-pull-request

interface GitHubPullRequest {
    additions: number;
    assignees: GitHubUser[];
    base: GitHubRef;
    body: null | string;
    changed_files: number;
    closed_at: null | string;
    comments: number;
    commits: number;
    created_at: string;
    deletions: number;
    draft: boolean;
    head: GitHubRef;
    html_url: string;
    id: number;
    labels: GitHubLabel[];
    locked: boolean;
    merge_commit_sha: null | string;
    mergeable: null | boolean;
    merged: boolean;
    merged_at: null | string;
    merged_by: null | GitHubUser;
    milestone: null | GitHubMilestone;
    number: number;
    requested_reviewers: GitHubUser[];
    review_comments: number;
    state: "open" | "closed";
    title: string;
    updated_at: string;
    user: GitHubUser;
}

Properties

additions assignees base body changed_files closed_at comments commits created_at deletions draft head html_url id labels locked merge_commit_sha mergeable merged merged_at merged_by milestone number requested_reviewers review_comments state title updated_at user

Properties

additions

additions: number

Number of line additions

assignees

assignees: GitHubUser[]

Users assigned to this pull request

base

base: GitHubRef

Target branch reference

body

body: null | string

Pull request body / description

changed_files

changed_files: number

Number of changed files

closed_at

closed_at: null | string

ISO 8601 timestamp of closing

comments

comments: number

Number of comments

commits

commits: number

Number of commits in this pull request

created_at

created_at: string

ISO 8601 timestamp of creation

deletions

deletions: number

Number of line deletions

draft

draft: boolean

Whether this is a draft pull request

head

head: GitHubRef

Source branch reference

html_url

html_url: string

URL to the pull request on GitHub

id

id: number

Unique numeric pull request ID (global across GitHub)

labels

labels: GitHubLabel[]

Labels applied to this pull request

locked

locked: boolean

Whether the pull request is locked

merge_commit_sha

merge_commit_sha: null | string

Merge strategy used (only set when merged)

mergeable

mergeable: null | boolean

Whether the pull request can be merged (null while GitHub computes it)

merged

merged: boolean

Whether the pull request has been merged

merged_at

merged_at: null | string

ISO 8601 timestamp of merging

merged_by

merged_by: null | GitHubUser

User who merged this pull request

milestone

milestone: null | GitHubMilestone

Milestone, if any

number

number: number

Pull request number within the repository

requested_reviewers

requested_reviewers: GitHubUser[]

Requested reviewers

review_comments

review_comments: number

Number of review comments

state

state: "open" | "closed"

Current state

title

title: string

Pull request title

updated_at

updated_at: string

ISO 8601 timestamp of last update

user

user: GitHubUser

Pull request author

Settings

Member Visibility

On This Page

Properties