Easily load and persist config without having to think about where and how
Config is stored in a JSON file located in $XDG_CONFIG_HOME
or ~/.config
.
Example: ~/.config/configstore/some-id.json
const Configstore = require('configstore');
const pkg = require('./package.json');
// Init a Configstore instance with an unique ID e.g.
// package name and optionally some default values
const conf = new Configstore(pkg.name, {foo: 'bar'});
conf.set('awesome', true);
console.log(conf.get('awesome'));
//=> true
console.log(conf.get('foo'));
//=> bar
conf.del('awesome');
console.log(conf.get('awesome'));
//=> undefined
Create a new Configstore instance config
.
Type: string
Name of your package.
Type: object
Default content to init the config store with.
Type: object
Type: boolean
Default: false
Store the config at $CONFIG/package-name/config.json
instead of the default $CONFIG/configstore/package-name.json
. This is not recommended as you might end up conflicting with other tools, rendering the "without having to think" idea moot.
Set an item.
Get an item.
Delete an item.
Delete all items.
Get all items as an object or replace the current config with an object:
conf.all = {
hello: 'world'
};
Get the item count.
Get the path to the config file. Can be used to show the user where the config file is located or even better open it for them.
BSD license
Copyright Google