File: req_timeout.Rd

package info (click to toggle)
r-cran-httr2 1.2.2-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 1,684 kB
  • sloc: sh: 13; makefile: 2
file content (23 lines) | stat: -rw-r--r-- 543 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/req-options.R
\name{req_timeout}
\alias{req_timeout}
\title{Set time limit for a request}
\usage{
req_timeout(req, seconds)
}
\arguments{
\item{req}{A httr2 \link{request} object.}

\item{seconds}{Maximum number of seconds to wait}
}
\value{
A modified HTTP \link{request}.
}
\description{
An error will be thrown if the request does not complete in the time limit.
}
\examples{
# Give up after at most 10 seconds
request("http://example.com") |> req_timeout(10)
}