confs

Simple Configuration with defaults and required options

Allows you to set configuration requirements and defaults for your app or module, great when combined with Dotenv.

Currently supporting Number, String and Boolean values.

Written in TypeScript but works great with Vanilla JavaScript.

Does not mutate the objects you pass as options.

Install

$ npm install confs

Usage

const confs = require('confs').confs;
const config = confs({
    env: {
        database: "some",
    },
    transformBooleanStrings: true,
    transformNumberStrings: true,
    exitOnMissingRequired: false,
    required: {
        string: ["database"],
    },
    defaults: {
        string: {
            host: "localhost",
        },
        boolean: {
            sync: "true",
        },
        number: {
            port: "3306",
        }
    },
});


console.log(config.S('host'));
//=> "localhost"

console.log(config.string('host'));
//=> "localhost"

console.log(config.B('sync'));
//=> true

console.log(config.boolean('sync'));
//=> true

console.log(config.N('port'));
//=> 3306

console.log(config.number('port'));
//=> 3306

Options

transformBooleanStrings (default: false)

If set to true will transform all env strings containing "true" or "false" to their actual boolean values.

transformNumberStrings (default: false)

If set to true will transform all values from env to number, only ones that don't return NaN using parseFloat.

exitOnMissingRequired (default: true)

Will use your defined exit function when a required value is missing, useful to exit from node process with something like:

const confs = require('confs').confs;

const config = confs({
    env: {},
    exit: (message) => {
        console.error(message);
        process.exit(1);
    },
    exitOnMissingRequired: false,
    required: {
        string: ["name"],
    },
});


config.S('name');
//=> Will run exit, ending the program

throwOnNotFound (default: false)

Raises an error when an option is not found in your env object.

defaults

Your default options, separated by number, string and boolean values.

const config = confs({
    // ...
    defaults: {
        string: {
            name: "localhost",
        },
        boolean: {
            verbose: true,
        },
        number: {
            port: 3306,
        }
    },
});

required

Your required options, separated by number, string and boolean values.

const config = confs({
    // ...
    required: {
        string: ["host"],
        boolean: ["verbose"],
        number: ["port"],
    },
});

env

The actual object with your configuration values.

Can be used with Dotenv:

// npm install --save dotenv
require('dotenv').config();

const confs = require("confs").confs;
const config = confs({
    env: process.env,
    // ...
});

exit

Your exit function, only used when exitOnMissingRequired is set as true.

Usually you want to end your program (Node) when some required configuration is not found.

See exitOnMissingRequired for an example.

Methods

S / string

Used to get a config option that is a string.

config.S("name");
// => "Confs"

config.string("name");
// => "Confs"

N / number

Used to get a config option that is a number.

config.N("port");
// => 3306

config.number("port");
// => 3306

B / boolean

Used to get a config option that is a number.

config.B("verbose");
// => true

config.boolean("verbose");
// => true

License

MIT © Pablo Rosales