Dotenv (dotenv v3.1.0)

This module implements both an OTP application API and a "serverless" API.

Server API

Start the application with start/2 On starting, it will automatically export the environment variables in the default path (.env).

The environment can then be reloaded with reload!/0 or a specific path or list of paths can be provided to reload!/1.

Serverless API

To use the serverless API, you can either load the environment variables with load! (again, optionally passing in a path or list of paths), or you can retrieve the variables without exporting them using load.

Link to this section Summary

Functions

env()

Returns the current state of the server as a Dotenv.Env struct.

get(key, fallback \\ nil)

Retrieves the value of the given key from the server, or fallback if the value is not found.

load(env_path \\ :automatic)

Reads the env files at the provided env_path path(s) and returns the values in a Dotenv.Env struct.

load!(env_path \\ :automatic)

Reads the env files at the provided env_path path(s), exports the values into the system environment, and returns them in a Dotenv.Env struct.

parse_contents(contents)

reload!()

Calls the server to reload the values in the .env file into the system environment.

reload!(env_path)

Calls the server to reload the values in the file located at env_path into the system environment.

start(type, env_path \\ :automatic)

Callback implementation for Application.start/2.

Link to this section Functions

env()

Specs

env() :: Dotenv.Env.t()

Returns the current state of the server as a Dotenv.Env struct.

get(key, fallback \\ nil)

Specs

get(String.t(), String.t() | nil) :: String.t()

Retrieves the value of the given key from the server, or fallback if the value is not found.

load(env_path \\ :automatic)

Specs

load(String.t() | :automatic | [String.t()]) :: Dotenv.Env.t()

Reads the env files at the provided env_path path(s) and returns the values in a Dotenv.Env struct.

load!(env_path \\ :automatic)

Reads the env files at the provided env_path path(s), exports the values into the system environment, and returns them in a Dotenv.Env struct.

parse_contents(contents)

reload!()

Specs

reload!() :: :ok

Calls the server to reload the values in the .env file into the system environment.

This call is asynchronous (cast).

reload!(env_path)

Specs

reload!(any()) :: :ok

Calls the server to reload the values in the file located at env_path into the system environment.

This call is asynchronous (cast).

start(type, env_path \\ :automatic)

Callback implementation for Application.start/2.