add async eg to mocking man file and mention async support on it

R/mocking.R

@@ -1,4 +1,7 @@
 #' Mocking HTTP requests
+#' 
+#' Works for both synchronous requests via [HttpClient()] and async
+#' requests via [Async()] and [AsyncVaried()]
 #'
 #' @export
 #' @param on (logical) turn mocking on with `TRUE` or turn off with `FALSE`.
@@ -7,7 +10,6 @@
 #' @examples \dontrun{
 #' 
 #' if (interactive()) {
-#'   # load webmockr
 #'   library(webmockr)
 #'   library(crul)
 #'
@@ -18,7 +20,6 @@
 #'
 #'   # stub a request
 #'   stub_request("get", file.path(URL, "get"))
-#'   webmockr:::webmockr_stub_registry
 #'
 #'   # create an HTTP client
 #'   (x <- HttpClient$new(url = URL))
@@ -31,6 +32,22 @@
 #'   x$get('get', query = list(foo = "bar"))
 #'   webmockr::webmockr_disable_net_connect()
 #'   x$get('get', query = list(foo = "bar"))
+#' 
+#'   # With Async
+#'   urls <- c(
+#'    file.path(URL, "get"),
+#'    file.path(URL, "anything"),
+#'    file.path(URL, "encoding/utf8")
+#'   )
+#'   
+#'   for (u in urls) {
+#'     webmockr::stub_request("get", u) %>% 
+#'       webmockr::to_return(body = list(mocked = TRUE))
+#'   }
+#' 
+#'   async_con <- Async$new(urls = urls)
+#'   async_resp <- async_con$get()
+#'   lapply(async_resp, \(x) x$parse("UTF-8"))
 #' }
 #' 
 #' }