1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/sass_cache.R
\name{sass_cache_get}
\alias{sass_cache_get}
\title{Get default sass cache object for the current context}
\usage{
sass_cache_get()
}
\description{
Get the default sass cache object, for the current context. The context
depends on factors described below.
\code{sass_cache_get()} first checks the \code{sass.cache} option. If it is set to
\code{NULL} or \code{FALSE}, then this function returns \code{NULL}. If it has been set to a string,
it is treated as a directory name, and this function returns a
\code{sass_file_cache()} object using that directory. If the option has been set
to a \code{sass_file_cache()} object, then it will return that object.
In most cases, this function uses the user's cache directory, by calling
\code{tools::R_user_dir("sass", which = "cache")} (for R 4.0 and above) or
\code{rappdirs::user_cache_dir("R-sass")} (for older versions of R).
If this function is called from a Shiny application, it will also look for a
subdirectory named \verb{app_cache/}. If it exists, it will use a directory named
\verb{app_cache/sass/} to store the cache.
When running a Shiny application in a typical R session, it will not create
the \verb{app_cache/} subdirectory, but it will use it if present. This scopes the
cache to the application.
With Shiny applications hosted on Shiny Server and Connect, it \emph{will} create
a \verb{app_cache/sass/} subdirectory, so that the cache is scoped to the
application and will not interfere with another application's cache.
}
\section{Shiny Developer Mode}{
If Shiny Developer Mode is enabled (by setting \code{options(shiny.devmode = TRUE)} or calling \code{shiny::devmode(TRUE)},
the default global option value for \code{sass.cache} is updated to \code{FALSE} instead
of \code{TRUE}, similar to \code{getOption("sass.cache", FALSE)}. This setting allows
developers to make sure what is being returned from \code{\link[=sass]{sass()}} is not an incorrect
cache result.
}
\seealso{
\code{\link[=sass_cache_get_dir]{sass_cache_get_dir()}}, \code{\link[=sass]{sass()}}
}
|
