Config35

Constructors

booleanfunctionCreates a config for a boolean value parsed from common string representations.datefunctionCreates a config for a Date value parsed from a string.durationfunctionCreates a config for a Duration value parsed from a human-readable string.failfunctionCreates a config that always fails with the given error.finitefunctionCreates a config for a finite number (rejects NaN and Infinity).intfunctionCreates a config for an integer value.literalfunctionCreates a config that only accepts a specific literal value.literalsfunctionCreates a config that only accepts one of the specified literal values.logLevelfunctionCreates a config for a log level string.nonEmptyStringfunctionCreates a config for a non-empty string value.numberfunctionCreates a config for a numeric value (including NaN, Infinity).portfunctionCreates a config for a port number (integer in 1–65535).redactedfunctionCreates a config for a redacted string value.stringfunctionCreates a config for a single string value.succeedfunctionCreates a config that always succeeds with the given value, ignoring the provider entirely.urlfunctionCreates a config for a URL value parsed from a string.

Models

ConfiginterfaceA recipe for extracting a typed value T from a ConfigProvider.

Guards

isConfigconstReturns true if u is a Config instance.

Combinators

allfunctionCombines multiple configs into a single config that parses all of them.nestedconstScopes a config under a named prefix.optionconstMakes a config optional: returns Some(value) on success and None when data is missing.orElseconstProvides a fallback config when parsing fails with a ConfigError.withDefaultconstProvides a fallback value when the config fails due to missing data.

Mapping

mapconstTransforms the parsed value of a config with a pure function.mapOrFailconstTransforms the parsed value with a function that may fail.

Errors

ConfigErrorclassRepresents the error type produced when config loading or validation fails.

Schemas

Arrayconst BooleanconstSchema for boolean values encoded as strings.LogLevelconstSchema for LogLevel string literals.PortconstSchema for port numbers (integers in 1–65535).RecordconstSchema for key-value record types that can also be parsed from a flat comma-separated string.schemafunctionCreates a Config<T> from a Schema.Codec.

Utility Types

SuccesstypeExtracts the successfully parsed value type from a Config.

Wrap

unwrapconstConstructs a Config<T> from a value matching Wrap<T>.WraptypeUtility type that recursively replaces primitives with Config in a nested structure.