Function getEnvSettingsHelp

getEnvSettingsHelp(): string

Get a string that contains help which default process env are supported within the different getBasic***ConfigDefinitions that can be printed to the console or used any other way.

Returns string

Example

// get a list of all available settings:
console.log(getEnvSettingsHelp());

// print the usage of a single `getBasic***ConfigDefinitions` helper
const logger: LoggerFn = (varname: string, str: string) => {
 console.log(`${varname}: ${str}`);
}

getConfig(getBasicConfigDefinitions(undefined, logger));