Async configuration loader/validator built on top of shortstop
var joi = ; // used for validationsvar config = ;var schema =DATABASE_URL:description: 'The connection string for the Database'validate: joidefault: 'postgres://postgres@localhost:5432/testdb';;
config(schema, [options], callback)
The only method. Takes a schema object, optional options, and a callback.
The schema is parsed, resolved, populated and validated and the callback
is called with an error or an object containing the environment. Everything
is resolved using the
process.env with fallbacks to resolving the
property using shortstop and then the
The schema object is composed of keys for your environment. Each key is assigned a definition object comprised of 4 keywords. Instead of a definiton object, you can nest keys; However, if there are any keywords, the nesting will be ignored.
description(optional) - Used to describe your configuration. Not currently used internally, but allows for extra features in the future.
validate(required) - Used to validate and convert values to proper types. Accepts
default(optional) - Used to provide a default to your environment if the key can't be resolved or isn't in
resolve(optional) - String that resolves to a registered
shortstophandler. Note: No shortstop handlers are registered by default. They must be added using the
The options object allows you to register
shortstop handlers and adjust joi configuration.
handlers(optional) - Object containing key/handler pairs of shortstop handlers to register in the shortstop instance. The handler can be an array of handlers, each will be registered as the key.
joi(optional) - Object containing
joiconfiguration overrides. Note: In this module,
allowUnknownis defaulted to
abortEarlyis defaulted to
presenceis defaulted to
requiredinstead of the joi defaults.
The callback function is called once all resolution and validation is done. If resolution or
validation fails, the callback will be called with an error. If everything succeeds, the
argument will be an object containing the fully resolved environment. Also, the property
NODE_ENV will be resolved to
development if undefined in the environment and the properties
staging will be resolved to booleans based on
Note: environment variables will not be resolved if
false in the joi configuration.