Interface PullRequestsParams

Query parameters for listing pull requests.

See

https://docs.github.com/en/rest/pulls/pulls#list-pull-requests

interface PullRequestsParams {
    base?: string;
    direction?: "asc" | "desc";
    head?: string;
    page?: number;
    per_page?: number;
    sort?: "created" | "updated" | "popularity" | "long-running";
    state?: "all" | "open" | "closed";
}

Hierarchy (View Summary)

Properties

base? direction? head? page? per_page? sort? state?

Properties

Optionalbase

base?: string

Filter by base branch name

Optionaldirection

direction?: "asc" | "desc"

Sort direction

Optionalhead

head?: string

Filter by head branch (format: user:branch-name)

Optionalpage

page?: number

Page number to retrieve (1-based). Use nextPage from the previous response to paginate forward.

Optionalper_page

per_page?: number

Maximum number of results per page. GitHub default is 30, maximum is 100.

Optionalsort

sort?: "created" | "updated" | "popularity" | "long-running"

Sort field

Optionalstate

state?: "all" | "open" | "closed"

Filter by state

Settings

Member Visibility

On This Page

Properties