Skogsrå v2.0.3 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.

Environment variable options

t()

Skogsra environment variable.

Types.

Functions

Environment variable struct.

Whether the Skogsra environment variable is cached or not.

Gets the default value for a Skogsra environment variable.

Creates a new Skogsra environment variable.

Gets the OS variable name for the Skogsra environment variable.

Whether the Skogsra environment variable is required or not.

Whether the Skogsra environment variable should skip config or not.

Whether the Skogsra environment variable should skip system or not.

Gets the type of the Skogsra environment variable.

Link to this section Types

Link to this type

app_name()

View Source
app_name() :: nil | atom()

Application name.

Key.

List of keys that lead to the value of the variable.

Link to this type

namespace()

View Source
namespace() :: nil | atom()

Variable namespace.

Link to this type

option()

View Source
option() ::
  {:skip_system, boolean()}
  | {:skip_config, boolean()}
  | {:os_env, binary()}
  | {:type, type()}
  | {:namespace, namespace()}
  | {:default, term()}
  | {:required, boolean()}
  | {:cached, boolean()}

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() :: [option()]

Environment variable options:

Link to this type

t()

View Source
t() :: %Skogsra.Env{
  app_name: app_name :: app_name(),
  keys: keys :: keys(),
  namespace: namespace :: namespace(),
  options: options :: options()
}

Skogsra environment variable.

Link to this type

type()

View Source
type() ::
  :binary
  | :integer
  | :float
  | :boolean
  | :atom
  | :module
  | :unsafe_module
  | module()

Types.

Link to this section Functions

Environment variable struct.

Link to this function

cached?(env)

View Source
cached?(t()) :: boolean()

Whether the Skogsra environment variable is cached or not.

Link to this function

default(env)

View Source
default(t()) :: term()

Gets the default value for a Skogsra environment variable.

Link to this function

new(namespace, app_name, keys, options)

View Source
new(namespace(), app_name(), key(), options()) :: t()
new(namespace(), app_name(), keys(), options()) :: t()

Creates a new Skogsra environment variable.

Gets the OS variable name for the Skogsra environment variable.

Link to this function

required?(env)

View Source
required?(t()) :: boolean()

Whether the Skogsra environment variable is required or not.

Link to this function

skip_config?(env)

View Source
skip_config?(t()) :: boolean()

Whether the Skogsra environment variable should skip config or not.

Link to this function

skip_system?(env)

View Source
skip_system?(t()) :: boolean()

Whether the Skogsra environment variable should skip system or not.

Gets the type of the Skogsra environment variable.