Cross-platform directory lookup for Clojure, ClojureScript on Node, and ClojureDart.
The public API returns strings or vectors of strings and never creates directories.
See config-home, data-home, state-home, and home-dir.
Cross-platform directory lookup for Clojure, ClojureScript on Node, and ClojureDart. The public API returns strings or vectors of strings and never creates directories. - arity 0 returns the base directory - arity 1 appends an application name - arity 2 appends qualifier, organization, and application using platform rules See [[config-home]], [[data-home]], [[state-home]], and [[home-dir]].
(audio-dir)Returns the user's audio or music directory, or nil when unresolved.
Returns the user's audio or music directory, or `nil` when unresolved.
(cache-home)(cache-home application)(cache-home qualifier organization application)Returns the writable user cache directory.
Returns the writable user cache directory.
(config-dir)(config-dir application)(config-dir qualifier organization application)Alias of config-home.
Alias of [[config-home]].
(config-dirs)(config-dirs application)(config-dirs qualifier organization application)Returns the shared configuration search roots as a vector of strings.
Returns the shared configuration search roots as a vector of strings.
(config-home)(config-home application)(config-home qualifier organization application)Returns the writable user configuration directory.
Returns the writable user configuration directory.
(data-dirs)(data-dirs application)(data-dirs qualifier organization application)Returns the shared data search roots as a vector of strings.
Returns the shared data search roots as a vector of strings.
(data-home)(data-home application)(data-home qualifier organization application)Returns the writable user data directory.
Returns the writable user data directory.
(desktop-dir)Returns the user's desktop directory, or nil when unresolved.
Returns the user's desktop directory, or `nil` when unresolved.
(document-dir)Returns the user's documents directory, or nil when unresolved.
Returns the user's documents directory, or `nil` when unresolved.
(download-dir)Returns the user's downloads directory, or nil when unresolved.
Returns the user's downloads directory, or `nil` when unresolved.
(executable-dir)(executable-dir application)(executable-dir qualifier organization application)Returns the user executable directory, or nil when unsupported.
Returns the user executable directory, or `nil` when unsupported.
(font-dir)Returns the user's font directory, or nil when unsupported.
Returns the user's font directory, or `nil` when unsupported.
(home-dir)Returns the user's home directory.
Returns the user's home directory.
(picture-dir)Returns the user's pictures directory, or nil when unresolved.
Returns the user's pictures directory, or `nil` when unresolved.
(preference-dir)(preference-dir application)(preference-dir qualifier organization application)Returns the preference directory.
Returns the preference directory.
(public-dir)Returns the user's public sharing directory, or nil when unresolved.
Returns the user's public sharing directory, or `nil` when unresolved.
(runtime-dir)(runtime-dir application)(runtime-dir qualifier organization application)Returns the runtime directory, or nil on platforms without one.
Returns the runtime directory, or `nil` on platforms without one.
(state-dir)(state-dir application)(state-dir qualifier organization application)Alias of state-home.
Alias of [[state-home]].
(state-home)(state-home application)(state-home qualifier organization application)Returns the writable user state directory.
Returns the writable user state directory.
(template-dir)Returns the user's templates directory, or nil when unsupported or unresolved.
Returns the user's templates directory, or `nil` when unsupported or unresolved.
(video-dir)Returns the user's videos directory, or nil when unresolved.
Returns the user's videos directory, or `nil` when unresolved.
cljdoc builds & hosts documentation for Clojure/Script libraries
| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |