kea-config

v0.2.3

Published

2 years ago

Configuration manager support merging configurations base on Node.js environment, references to other keys and using templates with objects for complex string values

Downloads

0High
0Medium
0Low

pencroff

conf config configuration settings store config manager config file load config

kea-config

Configuration manager for Node.js applications with perfect performance and without dependencies. Main feature of this configuration manager is merging configuration files depending on Node.js environment, support references to other keys and using templates with objects for complex string values.


    configManager.setup('./config');
    // For process.env.NODE_ENV === 'development';
    configManager.get('web.port'); // 4343
    // For process.env.NODE_ENV === 'production';
    configManager.get('web.port'); // 7474

    // If you don't want to apply changes connected to environment
    // just use init method
    configManager.init('./config/main.conf.js');
    configManager.get('web.port'); // 3005


    var config = {}

    config.web = {
        port: 3005,
        sessionKey: '6ketaq3cgo315rk9',
        paging: {
            defaultPageSize: 25,
            numberVisiblePages: 10
        },
        mongoDb: {
            username: 'dbUser',
            password: 'strongPassword',
            host: 'localhost',
            port: 27101,
            db: 'database'
        },
        propertyReference: {
            $ref: 'web.paging.defaultPageSize'
        },
        templateReference: {
            $ref: 'web.mongoDb',
            $tmpl: 'mongodb://{username}:{password}@{host}:{port}/{db}'
        }
    };

    module.exports = config;


    var config = {}

    config.web = {
        port: 4343
    };

    module.exports = config;


    var config = {}

    config.web = {
        port: 7474
    };

    module.exports = config;

Install with npm:

npm install kea-config --save

In your code require the package:

var configManager = require('kea-config');

Setup configuration data

configManager.setup('./config');

This command will initialize configManager by main.conf.js in and then merge development.conf.js (if NODE_ENV === development)

Read (get) and write (set) config data:


    var sessionSecret = configManager.get('web.sessionKey');
    configManager.set('web.paging.defaultPageSize', 15);
    // also
    webConfig = configManager.get('web.paging');
    /*
        {
            defaultPageSize: 15,
            numberVisiblePages: 10
        }
    */

    // Usage references

    configManager.get('web.propertyReference'); // 25

    // Usage templates

    configManager.get('web.templateReference'); // 'mongodb://dbUser:strongPassword@localhost:27101/database' - string

npm test or gulp mocha - run tests
gulp cover - check tests coverage
gulp benchmark - rum performance test
gulp readme - prepare README.md from documentation folder

Statements ................................... 100% ( 123/123 )
Branches ..................................... 96.67% ( 58/60 )
Functions .................................... 100% ( 20/20 )
Lines ........................................ 100% ( 123/123 )

Get simple key ............................... 5,799,240 ops/sec +0.47%
Get deep key ................................. 5,488,370 ops/sec +0.31%
Get key with reference ....................... 1,508,501 ops/sec +0.23%
Get key with reference and template .......... 106,877 ops/sec +0.27%
Get key with deep references ................. 274,983 ops/sec +0.80%
Get key with deep references and template .... 108,919 ops/sec +0.25%
Set simple key ............................... 3,446,469 ops/sec +0.26%
Set deep key ................................. 3,135,072 ops/sec +1.82%

support .yml, .yaml, .coffee, .cson, .properties, .json, .json5, .hjson
adapters for different storages like (filesystem, DB, localstorage / sessionstorage, web api and etc.)
save current state of config
delete key

MIT

Image from thetartankiwi

kea-config
- .setup(dirPath)
- .init(path)
- .update(path)
- .setData(data, isMerge)
- .getData()
- .get(key) ⇒ *
- .set(key, value)
- .has(key) ⇒ boolean

kea-config.setup(dirPath)

Full init config based on environment variable NODE_ENV. If NODE_ENV not available use development as default. This method looking for two files main (name started from 'main' word) and file with name started from environment (like development, staging, production)