These functions pass their arguments to base::gsub()
in order to find and
replace string patterns (regular expressions) within request
or response
objects. gsub_request()
replaces in the request URL and any request body
fields; gsub_response()
replaces in the response URL, the response body,
and it calls gsub_request()
on the request
object found within the
response
.
gsub_response(response, pattern, replacement, ...)gsub_request(request, pattern, replacement, ...)
A request
or response
object, same as was passed in, with the
pattern replaced in the URLs and bodies.
An 'httr' response
object to sanitize.
From base::gsub()
: "character string containing a regular
expression (or character string for fixed = TRUE
) to be matched in the
given character vector." Passed to gsub()
. See the docs for gsub()
for
further details.
A replacement for the matched pattern, possibly including
regular expression backreferences. Passed to gsub()
. See the docs for
gsub()
for further details.
Additional logical arguments passed to gsub()
: ignore.case
,
perl
, fixed
, and useBytes
are the possible options.
An 'httr' request
object to sanitize.
Note that, unlike gsub()
, the first argument of the function is request
or response
,
not pattern
, while the equivalent argument in gsub()
, "x
", is placed
third. This difference is to maintain consistency with the other redactor
functions in httptest
, which all take response
as the first argument.