Interface CheckRunsParams

Query parameters for listing check runs.

See

https://docs.github.com/en/rest/checks/runs#list-check-runs-for-a-git-reference

interface CheckRunsParams {
    app_id?: number;
    check_name?: string;
    page?: number;
    per_page?: number;
    status?: "queued" | "in_progress" | "completed";
}

Hierarchy (View Summary)

Properties

app_id? check_name? page? per_page? status?

Properties

Optionalapp_id

app_id?: number

Filter by app slug

Optionalcheck_name

check_name?: string

Filter by check 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.

Optionalstatus

status?: "queued" | "in_progress" | "completed"

Filter by status

Settings

Member Visibility

On This Page

Properties