Functions to to help retrieving values from process.env
.
npm install --save env-helpers
yarn add env-helpers
pnpm add env-helpers
The functions are as follows:
Types
function envStr(key: string, defaultValue: string): string;
function envStr(key: string, defaultValue?: string): string | undefined;
Usage
envStr('FOO'): string | undefined
envStr('FOO', 'Fallback'): string
Types
function envInt(key: string, defaultValue: number, radix?: number = 10): number;
function envInt(key: string, defaultValue?: number, radix?: number = 10): number | undefined;
Usage
envInt('FOO'): number | undefined
envInt('FOO', 10, 16): number
Types
function envBool(key: string, defaultValue?: boolean): // boolean;
Usage
envBoolean('FOO'): boolean
envBoolean('FOO', false): boolean
Types
function envList(key: string, defaultValue: string[]): string[];
function envList(key: string, defaultValue?: string[]): string[] | [];
Usage
envList('FOO'): string[] | []
envList('FOO', ['a','b','c']): string[]
Types
function envJSON<T extends object>(key: string, defaultValue: T): T;
function envJSON<T extends object>(key: string, defaultValue?: T): T | undefined;
Usage
envJSON<{ [key: string]: string }>('FOO'): { [key: string]: string } | undefined
envJSON<{ biz: string }>('FOO', { biz: 'baz' }): { biz: string }