@taktikorg/ipsam-voluptatum v5.6.86

@taktikorg/ipsam-voluptatum

use .env files in your projects

With @taktikorg/ipsam-voluptatum you have the opportunity to use environment variables directly in your project.\ You can parse .env files and add them to the global variables process.env. \ You can also specify default values with @taktikorg/ipsam-voluptatum. These values are used if there is no environment variable.\ This makes it easier to check for errors and use standard configurations.

You also have the option to define nested variables, arrays and objects in the environment file \ You can use inline comments and masked hashtags (\#)

This module is compatible with processenv from TheNativeWeb. I would like to thank the team at TheNativeWeb very much.

Click here to go to the GitHub page of processenv by TheNativeWeb

TheNativeWeb GitHub

Click here to go to the npmjs page of processenv by TheNativeWeb

TheNativeWeb npmjs

Version 2.0.2

checkout the Changelog

Documentation

checkout the documentation

Installation

$ npm install @taktikorg/ipsam-voluptatum

get environment variables

# this .env file is a example
MODE=live
IGNORED=${HOME_PATH}
HOME_PATH=/var/www
LOG_PATH=${HOME_PATH}/log
ACCESS_LOG='${LOG_PATH}/access.log'
ERROR_LOG=${LOG_PATH}/error.log
ERROR_MODE='{ "info": "${LOG_PATH}/info.log", "fatal": "${LOG_PATH}/fatal.log", "exception": "${LOG_PATH}/exception.log" }'
ERROR_MODE_ARRAY='[ "info\\#with masked hash", "fatal", "exception" ]'
INLINE_COMMENT='this is a inline comment #not parsed'
INLINE_COMMENT_WITH_ESCAPE='this is an inline comment \# with masked hash'

basic usage

const { processenv } = require('@taktikorg/ipsam-voluptatum');
const home_path = processenv('HOME_PATH');

full usage

const { processenv } = require('@taktikorg/ipsam-voluptatum');

const getAllEnv = processenv();
/* output: all environment  variables */

const getAllEnvCallback = processenv((env) => {
  return env;
});
/* output: all environment  variables */

const getEnvByKey = processenv('MODE');
/* output: live */

const getEnvByKeyWithDefaultValue = processenv('MODE_TYPE', 'live');
/* output: live - MODE_TYPE does not exist */

const getEnvByKeyWithDefaultByCallback = processenv('MODE_TYPE', (val) => {
  return val ?? 'live';
});
/* output: live - MODE_TYPE does not exist */

const getEnvByKeyWithOperator = processenv('MODE_TYPE') ?? 'live';
/* output: live - MODE_TYPE does not exist */

const getEnvByKeyWithValidateCallback = processenv('MODE', (val) => {
  return val === 'live';
});
/* output: true - MODE is available and is live */

const getEnvByKeyWithAsyncCallback = await processenv('MODE', async (val) => {
  return val === 'live';
});
/* output: true - MODE is available and is live */

const getEnvByKeyWithInlineComment = await processenv('INLINE_COMMENT');
/* output: this is a inline comment */

const getEnvByKeyWithInlineCommentWithEscapedHash = await processenv('INLINE_COMMENT_WITH_ESCAPE_HASH');
/* output: this is a inline comment # with escaped hash */

END

Did you find any suggestions or bugs? Make a pull request or ask your question :-)