Header menu logo UnionConfig

Reader Module

Reading config vars from environment variables.

Functions and values

Function or value Description

read def

Full Usage: read def

Parameters:
Returns: Result<ConfigValue option, string>

Read a config var from environment, parse to typed value. Returns Result for composable error handling: - Required missing/empty → Error with message - Required invalid → Error with parse message - Optional missing/empty → Ok None - Optional invalid → Error with parse message - Valid → Ok (Some value)

def : ConfigVarDef
Returns: Result<ConfigValue option, string>

readBool def

Full Usage: readBool def

Parameters:
Returns: bool

Read bool config var - fails if not set or invalid

def : ConfigVarDef
Returns: bool

readBoolOrDefault def defaultValue

Full Usage: readBoolOrDefault def defaultValue

Parameters:
Returns: bool

Read bool with default (for optional vars or missing values)

def : ConfigVarDef
defaultValue : bool
Returns: bool

readInt def

Full Usage: readInt def

Parameters:
Returns: int

Read int config var - fails if not set or invalid

def : ConfigVarDef
Returns: int

readIntOrDefault def defaultValue

Full Usage: readIntOrDefault def defaultValue

Parameters:
Returns: int

Read int with default (for optional vars or missing values)

def : ConfigVarDef
defaultValue : int
Returns: int

readString def

Full Usage: readString def

Parameters:
Returns: string

Read string config var - returns empty string if not set

def : ConfigVarDef
Returns: string

validateRequired defs

Full Usage: validateRequired defs

Parameters:
Returns: string list

Validate all required vars are set and have valid values. Returns a list of error messages for any missing or invalid vars.

defs : ConfigVarDef seq
Returns: string list

Type something to start searching.