Skip to content

Commit

Permalink
docs: document rhino::dev()
Browse files Browse the repository at this point in the history
  • Loading branch information
kamilzyla committed Aug 25, 2024
1 parent c7d9be7 commit 499a113
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions R/tools.R
Original file line number Diff line number Diff line change
@@ -1,3 +1,20 @@
#' Development mode
#'
#' Run application in development mode with automatic rebuilding and reloading.
#'
#' This function will launch the Shiny app in
#' [development mode](https://shiny.posit.co/r/reference/shiny/latest/devmode.html)
#' (as if `options(shiny.devmode = TRUE)` was set).
#' The app will be automatically reloaded whenever the sources change.
#'
#' Additionally, Rhino will automatically rebuild JavaScript and Sass in the background.
#' Please note that this feature requires Node.js.
#'
#' @param build_js Boolean. Rebuild JavaScript automatically in the background?
#' @param build_sass Boolean. Rebuild Sass automatically in the background?
#' @param ... Additional arguments passed to `shiny::runApp()`.
#' @return None. This function is called for side effects.
#'
#' @export
dev <- function(build_js = TRUE, build_sass = TRUE, ...) {
proc <- dev_build(build_js, build_sass)
Expand Down

0 comments on commit 499a113

Please sign in to comment.