Repository files navigation

Dotenv-dot adds dot-notation variable transformation on top ofdotenv. If you find yourself needing to condense environment variables into JSON variables, then dotenv-dot is your tool.

npm install dotenv --savenpm install dotenv-dot --save

Dot-notation variables are those which contain a dot (.) in their name. Add dot-notation variables to the.env file like any other variable.

MAIL_CONFIG.service=gmailMAIL_CONFIG.auth.user=noreply@domain.comMAIL_CONFIG.auth.pass=pass1234

Once the dotenv-dot transformer is executed, these variables will be condensed into a new variable namedMAIL_CONFIG.

MAIL_CONFIG='{"service":"gmail","auth":{"user":"noreply@domain.com","pass":"pass1234"}}'

As early as possible in your application, require dotenv and dotenv-dot. Then, execute dotenv-dot after dotenv.

constdotenv=require('dotenv');constdotenvDot=require('dotenv-dot').transform;constmyEnv=dotenv.config();constresults=dotenvDot();// only updates `process.env`

If you want to updateprocess.env and the output of thedotenv.config(), include the output as a parameter on the dotenv-dot transformer.

constmyEnv=dotenv.config();constresults=dotenvDot(myEnv);// updates `process.env` and `myEnv`

It is possible to use dotenv without adding variables toprocess.env. Dotenv-dot can also do the same.

constparsedOutput=dotenv.parse(`MAIL_CONFIG.service=gmailMAIL_CONFIG.auth.user=noreply@domain.comMAIL_CONFIG.auth.pass=pass1234`);constresults=dotenvDot(parsedOutput);

If you already have parsed output you may transform it without using dotenv.

constresults=dotenvDot({'MAIL_CONFIG.service':'gmail','MAIL_CONFIG.auth.user':'noreply@domain.com''MAIL_CONFIG.auth.pass':'pass1234'});

Default:false

You may turn on logging to help debug why certain keys or values are not being set as expected.

constmyEnv=dotenv.config();require('dotenv-dot').transform(myEnv,{debug:process.env.DEBUG});

Default:false

You may want to ignoreprocess.env when transforming the output of thedotenv.config(). When this option is turned onprocess.env will not be consulted or altered.

constmyEnv=dotenv.config();require('dotenv-dot').transform(myEnv,{ignoreProcessEnv:true});

import*asdotenvfrom'dotenv';importdotenvDotfrom'dotenv-dot';

Or, if only intending to accessprocess.env, the two modules should be loading in this order using their auto-imports:

import'dotenv/config';import'dotenv-dot/transform';

More information about theimport syntax is available on thedotenv repository.

Note: You may set thedebug option using the dotenv debugcommand line or environment variable. TheignoreProcessEnv option is irrelevant when using the auto-imports.

Arrays are added by using numbers to indicate the value's index in the resulting array.

THINGS.0='Was eaten by his others'THINGS.1='Thing One'THINGS.3='Wayward Thing Two'