node-application-config
Store your applications config where the operating system wants you to.
Installation
npm install --save application-config
Usage
var cfg = require('application-config')('App Name')
cfg.read(function (err, data) {
})
cfg.write({ n: 1337 }, function (err) {
})
cfg.trash(function (err) {
})
API
applicationConfig(name)
Creates and return a new instance with the provided name.
cfg.read(cb)
Read the stored configuration. Callback receives (err, data)
.
cfg.write(data, cb)
Write new configuration. Callback receives (err)
.
cfg.trash(cb)
Remove the stored configuration. Callback receives (err)
.
cfg.filePath
The path to the underlying file in which the configuration is stored.
Config location
Platform | Location |
---|
OS X | ~/Library/Application Support/<name>/config.json |
Linux (XDG) | $XDG_CONFIG_HOME/<name>/config.json |
Linux (Legacy) | ~/.config/<name>/config.json |
Windows (> Vista) | %LOCALAPPDATA%/<name>/config.json |
Windows (XP, 2000) | %USERPROFILE%/Local Settings/Application Data/<name>/config.json |
License
MIT