Dotenv

https://dotenv.hexdocs.pm/
Admin
Dotenv is an Elixir library that loads and parses .env files, exporting environment variables into...
Tokens:1,777
Snippets:21
Trust Score:9
Update:19 hours ago
Show doc for...
Tokens:
Raw
### start(type, env_path \\ :automatic)

Source: https://dotenv.hexdocs.pm/Dotenv.html

Callback implementation for Application.start/2. Starts the application and automatically exports the environment variables in the default path.

```APIDOC
## start(type, env_path \\ :automatic)

### Description
Callback implementation for `Application.start/2`. Starts the application and automatically exports the environment variables in the default path (`.env`).

### Method
Function

### Signature
`start(type, env_path \\ :automatic)`

### Parameters
- `type` - Required - The application start type.
- `env_path` (String.t() | :automatic) - Optional - The path to the env file. Defaults to `:automatic` which uses the default path (`.env`).

### Returns
- The result of the application start callback.
```

--------------------------------

### get(key, fallback \\ nil)

Source: https://dotenv.hexdocs.pm/Dotenv.html

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

```APIDOC
## get(key, fallback \\ nil)

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

### Method
Function

### Signature
`get(String.t(), String.t() | nil) :: String.t()`

### Parameters
- `key` (String.t()) - Required - The key to look up.
- `fallback` (String.t() | nil) - Optional - The value to return if the key is not found. Defaults to `nil`.

### Returns
- `String.t()` - The value associated with the key, or the fallback.
```

--------------------------------

### get(env, fallback, key)

Source: https://dotenv.hexdocs.pm/Dotenv.Env.html

Retrieves the value of the given environment variable key, returning a fallback value if the key is not present.

```APIDOC
## get(env, fallback, key)

### Description
Retrieves the value of the environment variable identified by `key` from the `Dotenv.Env` struct, returning the provided `fallback` value if the key is not found.

### Parameters
- `env` (t()) - Required - The Dotenv.Env struct containing the environment values.
- `fallback` (String.t()) - Required - The value to return if the key is not present.
- `key` (String.t()) - Required - The name of the environment variable to retrieve.

### Returns
- The value of the environment variable as a string, or the fallback value if not found.
```

--------------------------------

### get(env, key)

Source: https://dotenv.hexdocs.pm/Dotenv.Env.html

Retrieves the value of the given environment variable key from the Dotenv.Env struct.

```APIDOC
## get(env, key)

### Description
Retrieves the value of the environment variable identified by `key` from the `Dotenv.Env` struct.

### Parameters
- `env` (t()) - Required - The Dotenv.Env struct containing the environment values.
- `key` (String.t()) - Required - The name of the environment variable to retrieve.

### Returns
- The value of the environment variable as a string, or nil if not found.
```

--------------------------------

### load!(env_path \\ :automatic)

Source: https://dotenv.hexdocs.pm/Dotenv.html

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.

```APIDOC
## load!(env_path \\ :automatic)

### Description
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.

### Method
Function

### Signature
`load!(String.t() | :automatic | [String.t()]) :: Dotenv.Env.t()`

### Parameters
- `env_path` (String.t() | :automatic | [String.t()]) - Optional - The path or list of paths to the env files. Defaults to `:automatic` which uses the default path (`.env`).

### Returns
- `Dotenv.Env.t()` - The parsed environment variables.
```

--------------------------------

### env()

Source: https://dotenv.hexdocs.pm/Dotenv.html

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

```APIDOC
## env()

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

### Method
Function

### Signature
`env() :: Dotenv.Env.t()`

### Parameters
None

### Returns
- `Dotenv.Env.t()` - The current state of the server.
```

--------------------------------

### load(env_path \\ :automatic)

Source: https://dotenv.hexdocs.pm/Dotenv.html

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

```APIDOC
## load(env_path \\ :automatic)

### Description
Reads the env files at the provided `env_path` path(s) and returns the values in a `Dotenv.Env` struct. This function does not export the variables to the system environment.

### Method
Function

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

### Parameters
- `env_path` (String.t() | :automatic | [String.t()]) - Optional - The path or list of paths to the env files. Defaults to `:automatic` which uses the default path (`.env`).

### Returns
- `Dotenv.Env.t()` - The parsed environment variables.
```

--------------------------------

### reload!()

Source: https://dotenv.hexdocs.pm/Dotenv.html

Calls the server to reload the values in the .env file into the system environment. This call is asynchronous (cast).

```APIDOC
## reload!()

### Description
Calls the server to reload the values in the `.env` file into the system environment. This call is asynchronous (`cast`).

### Method
Function

### Signature
`reload!() :: :ok`

### Parameters
None

### Returns
- `:ok` - Indicates the reload request was accepted.
```

--------------------------------

### path(env)

Source: https://dotenv.hexdocs.pm/Dotenv.Env.html

Returns the path(s) of the dotenv file(s) that were loaded into the Dotenv.Env struct.

```APIDOC
## path(env)

### Description
Returns the list of file paths from which the environment variables were loaded.

### Parameters
- `env` (t()) - Required - The Dotenv.Env struct containing the loaded paths.

### Returns
- A list of strings representing the file paths.
```

--------------------------------

### reload!(env_path)

Source: https://dotenv.hexdocs.pm/Dotenv.html

Calls the server to reload the values in the file located at env_path into the system environment. This call is asynchronous (cast).

```APIDOC
## reload!(env_path)

### Description
Calls the server to reload the values in the file located at `env_path` into the system environment. This call is asynchronous (`cast`).

### Method
Function

### Signature
`reload!(any()) :: :ok`

### Parameters
- `env_path` (any()) - Required - The path to the env file to reload.

### Returns
- `:ok` - Indicates the reload request was accepted.
```
Tokens:
Raw