@avanio/variable-util v1.1.0

@avanio/variable-util

getConfigVariable

getConfigVariable is a utility function that extracts configuration values from different sources like environment variables and even fetches remote configuration values. Also have ability to parse (and verify) string, URL and JSON stringified or semicolon separated object values.

NodeJS Installation

npm i @avanio/variable-util
npm i url-polyfill # import this to code if you need to support URL in older nodejs versions

Browser Installation (use browserify events for compatibility)

npm i @avanio/variable-util events

Documentation

• ConfigMap
• getConfigVariable
• getConfigVariableResult
• getConfigObject
• getConfigObjectResult

Usage examples

Base ConfigMap project setup

// file: loaders.ts
const fetchEnv = new FetchConfigLoader<OverrideMap>(() => new Request('https://example.com/config.json'));
const env = new EnvConfigLoader<OverrideMap>(undefined, {PORT: 'HTTP_PORT'}); // loads from process.env, with override PORT key from HTTP_PORT value
const reactEnv = new ReactEnvConfigLoader<OverrideMap>(); // loads from process.env in react app
// other loaders like dotenv from "@avanio/variable-util-node" can be added here

export const loaders: IConfigLoader[] = [env, fetchEnv, reactEnv];

// file: envTypes.ts
export type MainEnv = {
	PORT: number;
	HOST: string;
	DEBUG: boolean;
	URL: URL;
};
export type TestEnv = {
	TEST: string;
	API_SERVER: URL;
};
// override keys helper for loaders to know current key names
export type OverrideMap = InferOverrideKeyMap<MainEnv & TestEnv>;

// file: env.ts
export const mainConfig = new ConfigMap<MainEnv>(
	{
		DEBUG: {parser: booleanParser(), defaultValue: false},
		HOST: {parser: stringParser(), defaultValue: 'localhost'},
		PORT: {parser: integerParser(), defaultValue: 3000},
		URL: {parser: new UrlParser({urlSanitize: true}), defaultValue: new URL('http://localhost:3000')},
	},
	loaders,
);

Complex parsers

// file: envParsers.ts

// Define the custom parser instances for the config values
const objectSchema = z.object({
	foo: z.string(),
	baz: z.string(),
	secret: z.string(),
});

// parses 'foo=bar;baz=qux;secret=secret' string to {foo: "bar", baz: "qux", secret: "secret"}
export const fooBarSemicolonParser = new SemicolonConfigParser({
	validate: (value) => objectSchema.parse(value),
	protectedKeys: ['secret'],
	showProtectedKeys: 'prefix-suffix', // shows secret value with few characters from start and end on logging
});

// parses '{"foo": "bar", "baz": "qux", "secret": "secret"}' string to {foo: "bar", baz: "qux", secret: "secret"}
export const fooBarJsonParser = new JsonConfigParser({
	validate: (value) => objectSchema.parse(value),
	protectedKeys: ['secret'],
	showProtectedKeys: 'prefix-suffix', // shows secret value with few characters from start and end on logging
});

export const urlParser = new UrlParser({urlSanitize: true}); // urlSanitize hides credentials from logs

Legacy setup

const fetchEnv = new FetchConfigLoader(() => new Request('https://example.com/config.json'));
const env = new EnvConfigLoader(); // loads from process.env
const reactEnv = new ReactEnvConfigLoader(); // loads from process.env in react app
export const loaders: IConfigLoader[] = [env, fetchEnv, reactEnv];

const valueFromEnv = getConfigVariable('TEST', loaders, stringParser(), undefined, {showValue: true});