Volt.Env (Volt v0.13.0)

Copy Markdown View Source

Load environment variables for client-side code.

Reads .env files via Dotenvy and exposes variables with configured prefixes as compile-time replacements for import.meta.env.* expressions.

Files loaded (in order, later overrides earlier)

  1. .env
  2. .env.local
  3. .env.{mode} (e.g. .env.production)
  4. .env.{mode}.local

Usage in source code

console.log(import.meta.env.VOLT_API_URL)
console.log(import.meta.env.MODE)   // "development" or "production"
console.log(import.meta.env.DEV)    // true/false
console.log(import.meta.env.PROD)   // true/false

Only variables matching :env_prefix are exposed to client code. The default prefix is "VOLT_".

Summary

Functions

define(opts \\ [])

Build a define map for compile-time replacement.

load_env_files(root, mode)

Load and merge .env files for the given mode.

Functions

define(opts \\ [])

@spec define(keyword()) :: %{required(String.t()) => String.t()}

Build a define map for compile-time replacement.

Options

  • :mode — build mode (default: "production")
  • :root — project root for .env files (default: cwd)
  • :env — extra variables to inject (takes precedence over files)
  • :env_prefix — exposed env prefix or prefixes (default: "VOLT_")

load_env_files(root, mode)

@spec load_env_files(String.t(), String.t()) :: %{required(String.t()) => String.t()}

Load and merge .env files for the given mode.