dotenv

v3.0.0

dotenv v3.0.0 Dotenv

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

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)

Called when an application is started

Link to this section Functions

Link to this function env() 
env() :: Dotenv.Env.t

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

Link to this function get(key, fallback \\ nil) 
get(String.t, String.t) :: String.t

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

Link to this function load(env_path \\ :automatic) 
load([String.t]) :: Dotenv.Env.t
load(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.

Link to this function 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.

Link to this function reload!() 
reload!() :: :ok

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

This call is asynchronous (cast).

Link to this function reload!(env_path) 
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).

Link to this function start(type, env_path \\ :automatic)

Called when an application is started.

This function is called when an the application is started using Application.start/2 (and functions on top of that, such as Application.ensure_started/2). This function should start the top-level process of the application (which should be the top supervisor of the application’s supervision tree if the application follows the OTP design principles around supervision).

start_type defines how the application is started:

  • :normal - used if the startup is a normal startup or if the application is distributed and is started on the current node because of a failover from another mode and the application specification key :start_phases is :undefined.
  • {:takeover, node} - used if the application is distributed and is started on the current node because of a failover on the node node.
  • {:failover, node} - used if the application is distributed and is started on the current node because of a failover on node node, and the application specification key :start_phases is not :undefined.

start_args are the arguments passed to the application in the :mod specification key (e.g., mod: {MyApp, [:my_args]}).

This function should either return {:ok, pid} or {:ok, pid, state} if startup is successful. pid should be the PID of the top supervisor. state can be an arbitrary term, and if omitted will default to []; if the application is later stopped, state is passed to the stop/1 callback (see the documentation for the c:stop/1 callback for more information).

use Application provides no default implementation for the start/2 callback.

Callback implementation for Application.start/2.