Header menu logo TDesu.FSharp

Env Module

Environment variable helpers.

Example

 let connStr = Env.requireVar "DATABASE_URL"
 let port = Env.getVarOr "8080" "PORT"
val connStr: obj
val port: obj

Functions and values

Function or value Description

Env.getVar name

Full Usage: Env.getVar name

Parameters:
    name : string

Returns: string option

Gets an environment variable as Some, or None if missing/empty. The environment variable name.

name : string
Returns: string option

Env.getVarOr defaultValue name

Full Usage: Env.getVarOr defaultValue name

Parameters:
    defaultValue : string
    name : string

Returns: string

Gets an environment variable, or a default if missing/empty. The fallback value. The environment variable name.

defaultValue : string
name : string
Returns: string

Env.requireVar name

Full Usage: Env.requireVar name

Parameters:
    name : string

Returns: string

Gets an environment variable, throwing if missing/empty. The environment variable name. When the variable is not set or empty.

name : string
Returns: string

Type something to start searching.