Interface ReviewCommentsParams

Query parameters for listing review comments.

See

https://docs.github.com/en/rest/pulls/comments#list-review-comments-on-a-pull-request

interface ReviewCommentsParams {
    direction?: "asc" | "desc";
    page?: number;
    per_page?: number;
    since?: string;
    sort?: "created" | "updated";
}

Hierarchy (View Summary)

Properties

direction? page? per_page? since? sort?

Properties

Optionaldirection

direction?: "asc" | "desc"

Sort direction

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.

Optionalsince

since?: string

Only return comments after this ISO 8601 date

Optionalsort

sort?: "created" | "updated"

Sort field

Settings

Member Visibility

On This Page

Properties