GithubHelp home page GithubHelp logo

config-load's Introduction


Load config from a tree of JS/JSON files

Current status

NPM version Build Status Dependency Status Dev dependency Status Coverage Status



npm install config-load


var configLoad = require('config-load');

configLoad([path] [, options])

Loads all JS/JSON config files under path, recursively gathering them from the tree structure.

Uses require-folder-tree - see docs for that for explanation of how files are loaded.

If path is not provided, defaults to process.cwd() + '/config'.



Environment type - creates a selector (see below).

Defaults to process.env.NODE_ENV || 'development'


Object determining what parts of the config object to switch dependent on selectors provided.

Defaults to { env: options.env }


If config file parsing produces:

    db: {
        server: 'localhost',
        database: 'myDB'
    env: {
        development: {
            db: {
                password: 'dev db password'
        production: {
            db: {
                password: 'production db password'
    otherSetting: 'foo'

Then calling:

configLoad(path, { selectors: { env: 'development' } } )


    db: {
        server: 'localhost',
        database: 'myDB',
        password: 'dev db password'
    otherSetting: 'foo'
null value

If a selector's value is null, it takes the name key only.

If config file parsing produces:

    url: '',
    local: {
        url: ''
configLoad(path, { selectors: { local: null } } )


    url: ''


Use npm test to run the tests. Use npm run cover to check coverage.




If you discover a bug, please raise an issue on Github.


Pull requests are very welcome. Please:

  • ensure all tests pass before submitting PR
  • add an entry to changelog
  • add tests for new features
  • document new functionality/API additions in README

config-load's People


overlookmotel avatar


 avatar  avatar  avatar

config-load's Issues

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because we are using your CI build statuses to figure out when to notify you about breaking changes.

Since we did not receive a CI status on the greenkeeper/initial branch, we assume that you still need to configure it.

If you have already set up a CI for this repository, you might need to check your configuration. Make sure it will run on all new branches. If you don’t want it to run on every branch, you can whitelist branches starting with greenkeeper/.

We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.