Liking cljdoc? Tell your friends :D

ol.dirs

platforms: clj, cljs

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.

data-home

clj

platforms: clj

(data-home)
(data-home application)
(data-home qualifier organization application)

Returns the writable user data directory.

source

cljs

platforms: cljs

(data-home)
(data-home application)
(data-home qualifier organization application)

Returns the writable user data directory.

source

config-home

clj

platforms: clj

(config-home)
(config-home application)
(config-home qualifier organization application)

Returns the writable user configuration directory.

source

cljs

platforms: cljs

(config-home)
(config-home application)
(config-home qualifier organization application)

Returns the writable user configuration directory.

source

state-home

clj

platforms: clj

(state-home)
(state-home application)
(state-home qualifier organization application)

Returns the writable user state directory.

source

cljs

platforms: cljs

(state-home)
(state-home application)
(state-home qualifier organization application)

Returns the writable user state directory.

source

data-dirs

clj

platforms: clj

(data-dirs)
(data-dirs application)
(data-dirs qualifier organization application)

Returns the shared data search roots as a vector of strings.

source

cljs

platforms: cljs

(data-dirs)
(data-dirs application)
(data-dirs qualifier organization application)

Returns the shared data search roots as a vector of strings.

source

config-dirs

clj

platforms: clj

(config-dirs)
(config-dirs application)
(config-dirs qualifier organization application)

Returns the shared configuration search roots as a vector of strings.

source

cljs

platforms: cljs

(config-dirs)
(config-dirs application)
(config-dirs qualifier organization application)

Returns the shared configuration search roots as a vector of strings.

source

cache-home

clj

platforms: clj

(cache-home)
(cache-home application)
(cache-home qualifier organization application)

Returns the writable user cache directory.

source

cljs

platforms: cljs

(cache-home)
(cache-home application)
(cache-home qualifier organization application)

Returns the writable user cache directory.

source

runtime-dir

clj

platforms: clj

(runtime-dir)
(runtime-dir application)
(runtime-dir qualifier organization application)

Returns the runtime directory, or nil on platforms without one.

source

cljs

platforms: cljs

(runtime-dir)
(runtime-dir application)
(runtime-dir qualifier organization application)

Returns the runtime directory, or nil on platforms without one.

source

executable-dir

clj

platforms: clj

(executable-dir)
(executable-dir application)
(executable-dir qualifier organization application)

Returns the user executable directory, or nil when unsupported.

source

cljs

platforms: cljs

(executable-dir)
(executable-dir application)
(executable-dir qualifier organization application)

Returns the user executable directory, or nil when unsupported.

source

preference-dir

clj

platforms: clj

(preference-dir)
(preference-dir application)
(preference-dir qualifier organization application)

Returns the preference directory.

source

cljs

platforms: cljs

(preference-dir)
(preference-dir application)
(preference-dir qualifier organization application)

Returns the preference directory.

source

home-dir

clj

platforms: clj

(home-dir)

Returns the user’s home directory.

source

cljs

platforms: cljs

(home-dir)

Returns the user’s home directory.

source

audio-dir

clj

platforms: clj

(audio-dir)

Returns the user’s audio or music directory, or nil when unresolved.

source

cljs

platforms: cljs

(audio-dir)

Returns the user’s audio or music directory, or nil when unresolved.

source

desktop-dir

clj

platforms: clj

(desktop-dir)

Returns the user’s desktop directory, or nil when unresolved.

source

cljs

platforms: cljs

(desktop-dir)

Returns the user’s desktop directory, or nil when unresolved.

source

document-dir

clj

platforms: clj

(document-dir)

Returns the user’s documents directory, or nil when unresolved.

source

cljs

platforms: cljs

(document-dir)

Returns the user’s documents directory, or nil when unresolved.

source

download-dir

clj

platforms: clj

(download-dir)

Returns the user’s downloads directory, or nil when unresolved.

source

cljs

platforms: cljs

(download-dir)

Returns the user’s downloads directory, or nil when unresolved.

source

font-dir

clj

platforms: clj

(font-dir)

Returns the user’s font directory, or nil when unsupported.

source

cljs

platforms: cljs

(font-dir)

Returns the user’s font directory, or nil when unsupported.

source

picture-dir

clj

platforms: clj

(picture-dir)

Returns the user’s pictures directory, or nil when unresolved.

source

cljs

platforms: cljs

(picture-dir)

Returns the user’s pictures directory, or nil when unresolved.

source

public-dir

clj

platforms: clj

(public-dir)

Returns the user’s public sharing directory, or nil when unresolved.

source

cljs

platforms: cljs

(public-dir)

Returns the user’s public sharing directory, or nil when unresolved.

source

template-dir

clj

platforms: clj

(template-dir)

Returns the user’s templates directory, or nil when unsupported or unresolved.

source

cljs

platforms: cljs

(template-dir)

Returns the user’s templates directory, or nil when unsupported or unresolved.

source

video-dir

clj

platforms: clj

(video-dir)

Returns the user’s videos directory, or nil when unresolved.

source

cljs

platforms: cljs

(video-dir)

Returns the user’s videos directory, or nil when unresolved.

source

state-dir

clj

platforms: clj

(state-dir)
(state-dir application)
(state-dir qualifier organization application)

Alias of state-home.

source

cljs

platforms: cljs

(state-dir)
(state-dir application)
(state-dir qualifier organization application)

Alias of state-home.

source

config-dir

clj

platforms: clj

(config-dir)
(config-dir application)
(config-dir qualifier organization application)

Alias of config-home.

source

cljs

platforms: cljs

(config-dir)
(config-dir application)
(config-dir qualifier organization application)

Alias of config-home.

source

❮API Referenceol.dirs❯

Can you improve this documentation?Edit on GitHub

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
←Move to previous article
→Move to next article
Ctrl+/Jump to the search field
Raise an issueBrowse cljdoc sourceChat on Slack
× close