Interface MilestonesParams

Query parameters for listing milestones.

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

Hierarchy (View Summary)

Properties

direction?: "asc" | "desc"

Sort direction

page?: number

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

per_page?: number

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

sort?: "due_on" | "completeness"

Sort field

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

Filter by state