From 78e713ad030c34f2d74a42b556b9e5ac9c66bb29 Mon Sep 17 00:00:00 2001 From: boB Rudis Date: Sun, 27 Aug 2017 18:14:50 -0400 Subject: [PATCH] forgot to document a new parameter --- R/helpers.r | 4 +++- man/get_response_body.Rd | 5 ++++- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/R/helpers.r b/R/helpers.r index 07f3747..21649c8 100644 --- a/R/helpers.r +++ b/R/helpers.r @@ -2,8 +2,10 @@ #' #' @md #' @param har_resp_obj HAR response object +#' @param type return type. If `raw` (default) then a raw vector of the content is returned. +#' If `text` then a character vector. #' @family splash_har_helpers -#' @return A `raw` vector of the content or `NULL` +#' @return A `raw` vector of the content or `NULL` or a `character` if `type` == `text` #' @export get_response_body <- function(har_resp_obj, type=c("raw", "text")) { type <- match.arg(type, c("raw", "text")) diff --git a/man/get_response_body.Rd b/man/get_response_body.Rd index 72f2153..a14b7ee 100644 --- a/man/get_response_body.Rd +++ b/man/get_response_body.Rd @@ -8,9 +8,12 @@ get_response_body(har_resp_obj, type = c("raw", "text")) } \arguments{ \item{har_resp_obj}{HAR response object} + +\item{type}{return type. If \code{raw} (default) then a raw vector of the content is returned. +If \code{text} then a character vector.} } \value{ -A \code{raw} vector of the content or \code{NULL} +A \code{raw} vector of the content or \code{NULL} or a \code{character} if \code{type} == \code{text} } \description{ Retrieve the body content of a HAR entry