Copyright | © 2015–2020 Stack Builders Inc. |
---|---|
License | MIT |
Maintainer | Stack Builders <hackage@stackbuilders.com> |
Stability | experimental |
Portability | portable |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
This module contains common functions to load and read dotenv files.
Synopsis
- load :: MonadIO m => Bool -> [(String, String)] -> m ()
- loadFile :: MonadIO m => Config -> m ()
- parseFile :: MonadIO m => FilePath -> m [(String, String)]
- onMissingFile :: MonadCatch m => m a -> m a -> m a
- configParser :: Parser [ParsedVariable]
- data Config = Config {}
- defaultConfig :: Config
Dotenv Load Functions
:: MonadIO m | |
=> Bool | Override existing settings? |
-> [(String, String)] | List of values to be set in environment |
-> m () |
Loads the given list of options into the environment. Optionally override existing variables with values from Dotenv files.
loadFile
parses the environment variables defined in the dotenv example
file and checks if they are defined in the dotenv file or in the environment.
It also allows to override the environment variables defined in the environment
with the values defined in the dotenv file.
:: MonadIO m | |
=> FilePath | A file containing options to read |
-> m [(String, String)] | Variables contained in the file |
Parses the given dotenv file and returns values without adding them to the environment.
:: MonadCatch m | |
=> m a | Action to perform that may fail because of missing file |
-> m a | Action to perform if file is indeed missing |
-> m a |
The helper allows to avoid exceptions in the case of missing files and perform some action instead.
Since: 0.3.1.0
configParser :: Parser [ParsedVariable] Source #
Returns a parser for a Dotenv configuration file. Accepts key and value
arguments separated by =
. Comments in all positions are handled
appropriately.
Dotenv Types
Configuration Data Types with extra options for executing dotenv.
Config | |
|
defaultConfig :: Config Source #
Default configuration. Use .env file without .env.example strict envs and without overriding.