Validation for your environment variables
Envalid is a small library for validating and accessing environment variables in Node.js programs, aiming to:
** Note: version 2.x of envalid only supports Node 6 and above, and the API is completely rewritten from version 0.x - 1.x. The older API docs are still available **
cleanEnv() returns a sanitized, immutable environment object, and accepts three
* an object containing your env vars (eg. process.env)
* an object literal that specifies the format of required vars.
* an object with options
cleanEnv() will log an error message and exit if any required
env vars are missing or invalid.
const envalid =const str email json = envalidconst env = envalid// Read an environment variable, which is validated and cleaned during// and/or filtering that you specified with cleanEnv().envADMIN_EMAIL // -> 'email@example.com'// Envalid parses NODE_ENV automatically, and provides the follwong// shortcut (boolean) properties for checking its value:envisProduction // true if NODE_ENV === 'production'envisTest // true if NODE_ENV === 'test'envisDev // true if NODE_ENV === 'development'
For an example you can play with, clone this repo and see the
process.env only stores strings, but sometimes you want to retrieve other types
(booleans, numbers), or validate that an env var is in a specific format (JSON,
url, email address). To these ends, the following validation functions are available:
str()- Passes string values through, will ensure an value is present unless a
defaultvalue is given.
bool()- Parses env var strings
"0", "1", "true", "false", "t", "f"into booleans
num()- Parses an env var (eg.
"42", "0.23", "1e5") into a Number
email()- Ensures an env var is an email address
url()- Ensures an env var is a url with a protocol and hostname
json()- Parses an env var with
Each validation function accepts an (optional) object with the following attributes:
desc- A string that describes the env var.
choices- An Array that lists the admissable parsed values for the env var.
default- A fallback value, which will be used if the env var wasn't specified. Providing a default effectively makes the env var optional.
devDefault- A fallback value to use only when
'production'. This is handy for env vars that are required for production environments, but optional for development and testing.
You can easily create your own validator functions with
envalid.makeValidator(). It takes
a function as its only parameter, and should either return a cleaned value, or throw if the
input is unacceptable:
const makeValidator cleanEnv =const twochars =const env =;
By default, if any required environment variables are missing or have invalid
values, envalid will log a message and call
process.exit(1). You can override
this behavior by passing in your own function as
options.reporter. For example:
const env =
Envalid wraps the very handy dotenv package,
so if you have a
.env file in your project, envalid will read and validate the
env vars there as well.