File: recording.Rd

package info (click to toggle)
r-cran-vcr 0.6.0%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 1,360 kB
  • sloc: cpp: 15; sh: 13; makefile: 2
file content (63 lines) | stat: -rw-r--r-- 1,720 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/recording.R
\name{recording}
\alias{recording}
\title{vcr recording options}
\description{
vcr recording options
}
\section{once}{

The \code{once} record mode will:
\itemize{
\item Replay previously recorded interactions.
\item Record new interactions if there is no cassette file.
\item Cause an error to be raised for new requests if there is a cassette file.
}

It is similar to the \code{new_episodes} record mode, but will prevent new,
unexpected requests from being made (i.e. because the request URI changed
or whatever).

\code{once} is the default record mode, used when you do not set one.
}

\section{none}{

The \code{none} record mode will:
\itemize{
\item Replay previously recorded interactions.
\item Cause an error to be raised for any new requests.
}

This is useful when your code makes potentially dangerous
HTTP requests.  The \code{none} record mode guarantees that no
new HTTP requests will be made.
}

\section{new_episodes}{

The \code{new_episodes} record mode will:
\itemize{
\item Record new interactions.
\item Replay previously recorded interactions.
}

It is similar to the \code{once} record mode, but will \strong{always} record new
interactions, even if you have an existing recorded one that is similar
(but not identical, based on the \code{match_request_on} option).
}

\section{all}{

The \code{all} record mode will:
\itemize{
\item Record new interactions.
\item Never replay previously recorded interactions.
}

This can be temporarily used to force \pkg{vcr} to re-record
a cassette (i.e. to ensure the responses are not out of date)
or can be used when you simply want to log all HTTP requests.
}