% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/api.R
\name{af_paginate}
\alias{af_paginate}
\alias{af_paginate_offset}
\alias{af_paginate_none}
\title{Pagination strategies}
\usage{
af_paginate_offset(
  where = c("header", "query"),
  limit_param = "limit",
  offset_param = "offset"
)

af_paginate_none()
}
\arguments{
\item{where}{Either \code{"header"} or \code{"query"}.}

\item{limit_param, offset_param}{Parameter names to use.}
}
\value{
An \code{apifetch_pagination} object.
}
\description{
Constructors describing how \code{limit}/\code{offset} are sent with a request. Pass
the result to the \code{pagination} argument of \code{\link[=af_api]{af_api()}}.
}
\details{
\itemize{
\item \code{af_paginate_offset()}: send \code{limit}/\code{offset} either as HTTP headers
(default, as the Big Data PE API expects) or as URL query parameters.
\item \code{af_paginate_none()}: send no pagination parameters.
}

Non-positive or infinite values are omitted from the request.
}
\examples{
af_paginate_offset("header")
af_paginate_offset("query", limit_param = "per_page")
af_paginate_none()
}
