Interface MilestonesParams

Query parameters for listing milestones.

See

https://docs.github.com/en/rest/issues/milestones#list-milestones

interface MilestonesParams {
    direction?: "asc" | "desc";
    page?: number;
    per_page?: number;
    sort?: "due_on" | "completeness";
    state?: "all" | "open" | "closed";
}

Hierarchy (View Summary)

Properties

direction? page? per_page? sort? state?

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.

Optionalsort

sort?: "due_on" | "completeness"

Sort field

Optionalstate

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

Filter by state

Settings

Member Visibility

On This Page

Properties