envaridator

envaridator

Docs | Contributing | Wiki

Envaridator is a small environment variable management and validation library. It provides

• type safe access to your environment based configuration
• validation of all variables before your app starts
• the ability to show a list of the environment vars (e.g. something you might want to do if a --help flag is passed)

Installation

Using yarn:

yarn add envaridator

or npm:

npm i --save envaridator

Basic usage:

Note: the below example uses toi to validate the variable, but you can use any function that converts the variable to the desired type, or throws an error if the conversion fails.

Importing:

import { Envaridator } from 'envaridator';

let envaridator = new Envaridator();

import * as toi from '@toi/toi';
import * as toix from '@toi/toix';

const oldDBURL = envaridator.register(
  'DB_URL',
  toi.optional().and(toix.str.url({ protocol: 'postgres' })),
  'The SQL database url. Must be a PostgreSQL database. Deprecated, use DATABASE_URL',
);

const newDBURL = envaridator.register(
  'DATABASE_URL',
  toi.optional().and(toix.str.url({ protocol: 'postgres' })),
  'The SQL database url. Must be a PostgreSQL database.',
);

envaridator.registerPostValidation('Either DB_URL or DATABASE_URL needs to defined.', () => {
  // if neither DB_URL or DATABASE_URL is defined, throw an error
  if (!(oldDBURL.value || newDBURL.value)) {
    throw new Error();
  }
});

if (process.env['HELP']) {
  console.log(envaridator.describeAll());
  process.exit(0);
}

try {
  envaridator.validate();
} catch (err) {
  console.error(err.message);
  process.exit(1);
}

// After this point, we can use the variables
const dbURL = newDBURL.value || oldDBURL.value;
let db = createDatabase({ url: dbURL });

If one or more registered environment variables fail the validation, envaridator will return a status report:

The following environment variables are invalid:

DATABASE_URL - Invalid protocol: mysql

You can also add post validation rules (by using envaridator.registerPostValidation) which you can use to add constraints across all variables. For example, you can use this feature to check migration of an environment variable.

Misc

Why separate registration from use?

• validate all variables at once, reporting all invalid values instead of just the first one
• validate all variables as a whole
• different parts of the app can import envaridator instance and register own variables during app "config" phase
• easy to show help listing all variables via envaridator.describeAll

License

Envaridator is MIT licensed.