Env.Decode

Config & IO

Decode process environment variables into Selm values.

Leaf decoders parse string env values ("3000" → Int, "true" → Bool). Use var for a required name (missing or bad → Err), or varOr when a default is fine if the key is unset. Compose with map / map2…map8 into your type, then run Env.decode or Env.load.

For record-shaped config, prefer Env.Decode.Pipeline (succeed Ctor |> required "HOST" string) over large mapN chains.

Types

Decoder

type Decoder a = Decoder

A decoder that turns the process environment into a value of type a.

Examples

Env.Decode.var "PORT" Env.Decode.int

Values

string

string : Decoder String

Decode an env value as a string.

Examples

Env.Decode.string

int

int : Decoder Int

Decode an env value as an integer ("3000" → 3000).

Examples

Env.Decode.int

bool

bool : Decoder Bool

Decode an env value as a boolean ("true" / "false", case-insensitive).

Examples

Env.Decode.bool

float

float : Decoder Float

Decode an env value as a float.

Examples

Env.Decode.float

var

var : String -> Decoder a -> Decoder a

Decode a named environment variable.

Fails when the variable is unset or the leaf decoder rejects the value.

Examples

Env.Decode.var "PORT" Env.Decode.int

varOr

varOr : String -> a -> Decoder a -> Decoder a

Decode a named environment variable, or use fallback when it is unset.

A present but invalid value still fails (for example PORT=abc with int).

Examples

Env.Decode.varOr "PORT" 3000 Env.Decode.int

optional

optional : String -> Decoder a -> Decoder (Maybe a)

Decode a named environment variable into Maybe.

Unset → Nothing. Present but invalid still fails.

Examples

Env.Decode.optional "CONDUIT_OTLP_ENDPOINT" Env.Decode.string

map

map : (a -> b) -> Decoder a -> Decoder b

Transform a decoder's result.

Examples

Env.Decode.map String.toUpper Env.Decode.string

map2

map2 : (a -> b -> c) -> Decoder a -> Decoder b -> Decoder c

Combine two decoders.

Examples

Env.Decode.map2 Config (Env.Decode.var "HOST" Env.Decode.string) (Env.Decode.var "PORT" Env.Decode.int)

map3

map3 : (a -> b -> c -> value) -> Decoder a -> Decoder b -> Decoder c -> Decoder value

Combine three decoders.

map4

map4 : (a -> b -> c -> d -> value) -> Decoder a -> Decoder b -> Decoder c -> Decoder d -> Decoder value

Combine four decoders.

map5

map5 : (a -> b -> c -> d -> e -> value) -> Decoder a -> Decoder b -> Decoder c -> Decoder d -> Decoder e -> Decoder value

Combine five decoders.

map6

map6 : (a -> b -> c -> d -> e -> f -> value) -> Decoder a -> Decoder b -> Decoder c -> Decoder d -> Decoder e -> Decoder f -> Decoder value

Combine six decoders.

map7

map7 : (a -> b -> c -> d -> e -> f -> g -> value) -> Decoder a -> Decoder b -> Decoder c -> Decoder d -> Decoder e -> Decoder f -> Decoder g -> Decoder value

Combine seven decoders.

map8

map8 : (a -> b -> c -> d -> e -> f -> g -> h -> value) -> Decoder a -> Decoder b -> Decoder c -> Decoder d -> Decoder e -> Decoder f -> Decoder g -> Decoder h -> Decoder value

Combine eight decoders.

succeed

succeed : a -> Decoder a

A decoder that always succeeds with the given value.

Examples

Env.Decode.succeed 42

fail

fail : String -> Decoder a

A decoder that always fails with the given message.

Examples

Env.Decode.fail "missing PORT"

andThen

andThen : (a -> Decoder b) -> Decoder a -> Decoder b

Run a second decoder depending on the first result.

Examples

Env.Decode.andThen (\n -> if n > 0 then Env.Decode.succeed n else Env.Decode.fail "PORT") Env.Decode.int