Skogsrå v1.2.0 Skogsra.Env View Source
This module defines a Skogsra
environment variable.
Link to this section Summary
Types
Application name
Key
List of keys that lead to the value of the variable
Variable namespace
Environment variable options.
skip_system
- Skips loading the variable from the OS.skip_config
- Skips loading the variable from the config.os_env
- The name of the OS environment variable.type
- Type to cast the OS environment variable value.namespace
- Default namespace for the variable.default
- Default value.required
- Whether the variable is required or not.cached
- Whether the variable is cached or not
Environment variable options
Skogsra environment variable
Types
Link to this section Types
Link to this type
app_name()
View Source
app_name()
View Source
app_name() :: nil | atom()
app_name() :: nil | atom()
Application name.
Link to this type
key()
View Source
key()
View Source
key() :: atom()
key() :: atom()
Key.
Link to this type
keys()
View Source
keys()
View Source
keys() :: [key()]
keys() :: [key()]
List of keys that lead to the value of the variable.
Link to this type
namespace()
View Source
namespace()
View Source
namespace() :: nil | atom()
namespace() :: nil | atom()
Variable namespace.
Link to this type
option() View Source
Environment variable options.
skip_system
- Skips loading the variable from the OS.skip_config
- Skips loading the variable from the config.os_env
- The name of the OS environment variable.type
- Type to cast the OS environment variable value.namespace
- Default namespace for the variable.default
- Default value.required
- Whether the variable is required or not.cached
- Whether the variable is cached or not.
Link to this type
options()
View Source
options()
View Source
options() :: [option()]
options() :: [option()]
Environment variable options:
Skogsra environment variable.
Link to this type
type() View Source
Types
Link to this section Functions
Link to this function
%Skogsra.Env{} View Source (struct)
Environment variable struct.
Link to this function
new(namespace, app_name, keys, options) View Source
Creates a new Skogsra
environment variable.