Skip to main content
Module

std/dotenv/mod.ts>LoadOptions

Deno standard library
Go to Latest
interface LoadOptions
import { type LoadOptions } from "https://deno.land/std@0.168.0/dotenv/mod.ts";

Properties

optional
envPath: string = "./.env"

Optional path to .env file.

optional
export: boolean = false

Set to true to export all .env variables to the current processes environment. Variables are then accessable via Deno.env.get(<key>).

optional
examplePath: string = "./.env.example"

Optional path to .env.example file.

optional
allowEmptyValues: boolean = false

Set to true to allow required env variables to be empty. Otherwise, it will throw an error if any variable is empty.

optional
defaultsPath: string = "./.env.defaults"

Path to .env.defaults file which is used to define default values.

# .env.defaults
# Will not be set if GREETING is set in base .env file
GREETING="a secret to everybody"
optional
restrictEnvAccessTo: StringList

List of Env variables to read from process. By default, the complete Env is looked up. This allows to permit access to only specific Env variables with --allow-env=ENV_VAR_NAME.