Browse Source

forgot to document a new parameter

boB Rudis 2 years ago
parent
commit
78e713ad03
No known key found for this signature in database
2 changed files with 7 additions and 2 deletions
  1. 3
    1
      R/helpers.r
  2. 4
    1
      man/get_response_body.Rd

+ 3
- 1
R/helpers.r View File

@@ -2,8 +2,10 @@
2 2
 #'
3 3
 #' @md
4 4
 #' @param har_resp_obj HAR response object
5
+#' @param type return type. If `raw` (default) then a raw vector of the content is returned.
6
+#'     If `text` then a character vector.
5 7
 #' @family splash_har_helpers
6
-#' @return A `raw` vector of the content or `NULL`
8
+#' @return A `raw` vector of the content or `NULL` or a `character` if `type` == `text`
7 9
 #' @export
8 10
 get_response_body <- function(har_resp_obj, type=c("raw", "text")) {
9 11
   type <- match.arg(type, c("raw", "text"))

+ 4
- 1
man/get_response_body.Rd View File

@@ -8,9 +8,12 @@ get_response_body(har_resp_obj, type = c("raw", "text"))
8 8
 }
9 9
 \arguments{
10 10
 \item{har_resp_obj}{HAR response object}
11
+
12
+\item{type}{return type. If \code{raw} (default) then a raw vector of the content is returned.
13
+If \code{text} then a character vector.}
11 14
 }
12 15
 \value{
13
-A \code{raw} vector of the content or \code{NULL}
16
+A \code{raw} vector of the content or \code{NULL} or a \code{character} if \code{type} == \code{text}
14 17
 }
15 18
 \description{
16 19
 Retrieve the body content of a HAR entry

Loading…
Cancel
Save