Liking cljdoc? Tell your friends :D

yummy.config


*die-fn*clj

source

configuration-environment-variableclj

(configuration-environment-variable program-name)

Yield an environment variable name which can be used to point to a configuration file path

Yield an environment variable name which can be used to point to a
configuration file path
sourceraw docstring

configuration-pathclj

(configuration-path program-name path)

Try to find a configuration path candidate by looking at provided paths, JVM properties, and the environment

Try to find a configuration path candidate by looking at provided paths,
JVM properties, and the environment
sourceraw docstring

configuration-propertyclj

(configuration-property program-name)

Yield a property name which can be used to point to a configuration file path

Yield a property name which can be used to point to a configuration
file path
sourceraw docstring

die!clj

(die! e msg)

Exit early

Exit early
sourceraw docstring

load-configclj

(load-config {:keys [spec program-name path die-fn] :as opts})

Load config from the filesystem. The path of the config file is resolved with configuration-path

Load config from the filesystem. The path of the config file
is resolved with `configuration-path`
sourceraw docstring

load-config-stringclj

(load-config-string input)
(load-config-string input {:keys [spec die-fn]})

Load configuration from a string, optionaly ensuring that the supplied spec is honored. An optional die-fn can be provided to report errors

Load configuration from a string, optionaly ensuring that the supplied
spec is honored. An optional `die-fn` can be provided to report errors
sourceraw docstring

safe-parseclj

(safe-parse data)

Parse YAML data or die with a helpful message

Parse YAML data or die with a helpful message
sourceraw docstring

safe-slurpclj

(safe-slurp path)

Slurp a file or die with a helpful message

Slurp a file or die with a helpful message
sourceraw docstring

spec-printerclj

A custom spec printer with more helpful messages

A custom spec printer with more helpful messages
sourceraw docstring

validateclj

(validate v spec)

Validate configuration against aspec or die with a helpful message

Validate configuration against aspec or die with a helpful message
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close