Toolkit

Appearance

Documentation / @andrew_l/toolkit / EnvParser

Interface: EnvParser ​

Environment variable parser

Properties ​

isDevelopment ​

isDevelopment: boolean

NODE_ENV is development

isProduction ​

isProduction: boolean

NODE_ENV is production

isStage ​

isStage: boolean

NODE_ENV is stage

isTest ​

isTest: boolean

NODE_ENV is test

Methods ​

bool() ​

bool(key, defaultValue?): boolean

Returns true when environment key has set to "true"

Returns defaultValue when key is not defined

Parameters ​

key ​

string

defaultValue? ​

boolean

Returns ​

boolean

decimal() ​

decimal(key, dights?, defaultValue?): number

Returns number when environment key has correct number value.

Returns defaultValue when environment key is not defined or has invalid number value

Parameters ​

key ​

string

dights? ​

number

defaultValue? ​

number

Returns ​

number

int() ​

int(key, defaultValue?): number

Returns number when environment key has correct number value.

Returns defaultValue when environment key is not defined or has invalid number value

Parameters ​

key ​

string

defaultValue? ​

number

Returns ​

number

json() ​

json<T>(key, defaultValue?): null | T

Returns parsed json value.

Returns defaultValue when key is not defined or invalid json value

Type Parameters ​

T ​

T = any

Parameters ​

key ​

string

defaultValue? ​

null | T

Returns ​

null | T

list() ​

list<T>(key, itemType, defaultValue?): ListTypeNameToType<T>[]

Returns array of parsed environment value.

Returns defaultValue when key is not defined

Type Parameters ​

T ​

T extends ListTypeName

Parameters ​

key ​

string

itemType ​

T

defaultValue? ​

ListTypeNameToType<T>[]

Returns ​

ListTypeNameToType<T>[]

string() ​

string(key, defaultValue?): string

Returns string when environment key has defined.

Returns defaultValue when environment key is not defined

Parameters ​

key ​

string

defaultValue? ​

string

Returns ​

string