environment-variable-service
v2.0.0
Published
A service to get environment variables in a more consistent and testable manor.
Downloads
185
Readme
environment-variable-service
A service to get environment variables in a more consistent and testable way.
Install
- If using yarn, run
yarn add environment-variable-service
- If using npm, run
npm install environment-variable-service
Usage
import { envVarService } from 'environment-variable-service';
# get env var; if doesn't exist, return undefined
const var1 = envVarService.getEnvironmentVariable('ENV_VAR_1');
# or
const var1 = envVarService.get('ENV_VAR_1');
# get env var; if doesn't exist, return default value
const var2 = envVarService.getEnvironmentVariableWithDefault('ENV_VAR_2', 'foobar');
# or
const var2 = envVarService.get('ENV_VAR_2', 'foobar');
# get env var; if doesn't exist, throw error
const var3 = envVarService.mustGetEnvironmentVariable('ENV_VAR_3');
#or
const var3 = envVarService.mustGet('ENV_VAR_3');
EnvironmentVariableService
Creates the service
// via import (this creates the service already)
import { envVarService } from 'environment-variable-service';
// or create directly
import { EnvironmentVariableService } from 'environment-variable-service';
const envVarService = new EnvironmentVariableService();
getEnvironmentVariable or get
Gets the requested environment variable returning undefined if doesn't exist
const var1 = envVarService.getEnvironmentVariable('ENV_VAR_1');
// or get
const var1 = envVarService.get('ENV_VAR_1');
getEnvironmentVariables or getAll
Gets the requested list of environment variables returning undefined for any that don't exist
const [var1, var2, var3] = envVarService.getEnvironmentVariables(['ENV_VAR_1', 'ENV_VAR_2', 'ENV_VAR_3']);
// or getAll
const [var1, var2, var3] = envVarService.getAll(['ENV_VAR_1', 'ENV_VAR_2', 'ENV_VAR_3']);
getEnvironmentVariableWithDefault or get with a default
Gets the requested environment variable returning the default value if doesn't exist
const var2 = envVarService.getEnvironmentVariableWithDefault('ENV_VAR_2', 'foobar');
// or get
const var2 = envVarService.get('ENV_VAR_2', 'foobar');
mustGetEnvironmentVariable or mustGet
Gets the requested environment variable throwing a Missing environment variable: ${variableName}
error if doesn't exist
const var3 = envVarService.mustGetEnvironmentVariable('ENV_VAR_3');
// or mustGet
const var3 = envVarService.mustGet('ENV_VAR_3');
mustGetEnvironmentVariables or mustGetAll
Gets the list of requested environment variables throwing a Missing environment variable: ${variableName}
error if one doesn't exist (all must exist otherwise, will throw error for first var that doesn't exist)
const [var1, var2, var3] = envVarService.mustGetEnvironmentVariables(['ENV_VAR_1', 'ENV_VAR_2', 'ENV_VAR_3']);
// or mustGet
const [var1, var2, var3] = envVarService.mustGetAll(['ENV_VAR_1', 'ENV_VAR_2', 'ENV_VAR_3']);
Publishing
- Make changes
- Create git commit using feat: for new features or fix: for updates
- Run yarn release:major, release:minor, release:patch for appropriate update (this will bump version number appropriately)
- Make PR back to main
- Upon merge to main, it will kick off action that will publish to npm