Interface GitHubPagedResponse<T>

Wrapper returned by GitHub paginated list endpoints.

Use values for the items, hasNextPage and nextPage for pagination.

let page = 1;
let hasMore = true;
while (hasMore) {
const res = await gh.user('octocat').repos({ per_page: 100, page });
process(res.values);
hasMore = res.hasNextPage;
page = res.nextPage ?? page + 1;
}
interface GitHubPagedResponse<T> {
    hasNextPage: boolean;
    nextPage?: number;
    totalCount?: number;
    values: T[];
}

Type Parameters

  • T

Properties

hasNextPage: boolean

Whether there are more pages available

nextPage?: number

The next page number, if hasNextPage is true

totalCount?: number

Total number of results (only available for search endpoints)

values: T[]

The items on the current page