gh (version 1.6.1)

gh_next: Get the next, previous, first or last page of results

Description

Get the next, previous, first or last page of results

Usage

gh_next(gh_response, .token = NULL, .send_headers = NULL)
gh_prev(gh_response, .token = NULL, .send_headers = NULL)
gh_first(gh_response, .token = NULL, .send_headers = NULL)
gh_last(gh_response, .token = NULL, .send_headers = NULL)

Value

Answer from the API.

Arguments

gh_response

An object returned by a gh() call.

.token

Authentication token. Defaults to gh_token().

.send_headers

Named character vector of header field values (except Authorization, which is handled via .token). This can be used to override or augment the default User-Agent header: "https://github.com/r-lib/gh".

Details

Note that these are not always defined. E.g. if the first page was queried (the default), then there are no first and previous pages defined. If there is no next page, then there is no next page defined, etc.

If the requested page does not exist, an error is thrown.

See Also

The .limit argument to gh() supports fetching more than one page.

Examples

if (FALSE) { # identical(Sys.getenv("IN_PKGDOWN"), "true")
x <- gh("/users")
vapply(x, "[[", character(1), "login")
x2 <- gh_next(x)
vapply(x2, "[[", character(1), "login")
}