@hypercolor/envconfig
v1.0.15
Published
Use decorators to pull in configuration data from environment variables or volume mounts.
Downloads
607
Readme
@hypercolor/envconfig
Table of Contents
Introduction
Use decorators to pull in configuration data from environment variables or volume mounts. Use the "fail fast" principle to ensure that all required variables are present before the application starts.
Adding the @requiredEnv or @optionalEnv decorator to a variable HOST_URL will do the following:
- If
process.env.HOST_URLis defined, use that value - If a volume mount is present at
/etc/config/env/HOST_URL, use that value - If a volume mount is present at
/etc/config/sec/HOST_URL, use that value - For
@requiredEnv, if none of the above are present, throw an error
Installation
- NPM
npm i @hypercolor/envconfig
- Yarn
yarn add @hypercolor/envconfig
Usage
import {requiredEnv} from '@hypercolor/envconfig';
export class ConfigVariables {
@requiredEnv() public ENVIRONMENT_NAME: string;
@requiredJsonEnv() public SOME_PRIVATE_KEY_JSON: IPrivateKeyJson;
@optionalEnv() public DEBUG?: string;
}