https://github.com/qard/jsonfig

Simple json config folder manager for node.js
https://github.com/qard/jsonfig

Last synced: about 1 month ago
JSON representation

Simple json config folder manager for node.js

• Host: GitHub
• URL: https://github.com/qard/jsonfig
• Owner: Qard
• Created: 2011-11-10T05:24:49.000Z (about 13 years ago)
• Default Branch: master
• Last Pushed: 2017-09-24T21:43:07.000Z (about 7 years ago)
• Last Synced: 2024-10-12T03:09:47.216Z (about 1 month ago)
• Language: JavaScript
• Homepage:
• Size: 112 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# JSONFig

JSONFig makes it dead easy to manage a folder full of json config files your app depends on.

## Requirements

* Node.js 0.4+

## Install

    npm install jsonfig

## Usage

    jsonfig.env('production').load(__dirname+'/config', function (conf) {

      console.log(conf.get('redis.host'))

    })

#### jsonfig.env(name)

Sets the environment name to scope to in your json configs, if available.

#### jsonfig.path(path)

Sets the folder to load json configs. NOTE: sub directories aren't supported yet. I'll deal with that later.

#### jsonfig.load([path], callback)

This tells jsonfig to start loading the json files and run the callback when it's complete. The callback takes two arguments (err, conf)

#### conf.get(path)

As a little bonus, the conf object passed into the jsonfig.load() callback includes a handy little helper for searching for values using a dot-path string. For example; conf.get('redis.host')

---

### Copyright (c) 2011 Stephen Belanger

#### Licensed under MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.