Docs/API Reference

API Reference

defineEnv(schema, config?)

Schema Options

OptionBehavior
type"string" | "number" | "boolean" | "enum"
defaultValueFallback if missing or empty string
validateCustom function (v) => boolean | string
validValuesRequired for "enum"
keyMaps schema key to process.env key
isSecretMasks value in debug logs

Config Options

  • loadEnv (boolean, default: false)

    If true, calls dotenv.config() before parsing.

  • debugMode (boolean, default: false)

    Logs all resolved variables with sources and masked secrets.

  • throw (boolean, default: true)

    Immediately exit process on failure vs accumulating errors.