Easily load and persist config without having to think about where and how

The config is stored in a JSON file located in $XDG_CONFIG_HOME or ~/.config.
Example: ~/.config/configstore/some-id.json

If you need this for Electron, check out electron-store instead.
And check out conf for a more modern version of configstore.

npm install configstore

import fs from 'node:fs';
import Configstore from 'configstore';
const packageJson = JSON.parse(fs.readFileSync('./package.json', 'utf8'));
// Create a Configstore instance.
const config = new Configstore(packageJson.name, {foo: 'bar'});
console.log(config.get('foo'));
//=> 'bar'
config.set('awesome', true);
console.log(config.get('awesome'));
//=> true
// Use dot-notation to access nested properties.
config.set('bar.baz', true);
console.log(config.get('bar'));
//=> {baz: true}
// Use default values with nullish coalescing
console.log(config.get('nonexistent') ?? 'default value');
//=> 'default value'
config.delete('awesome');
console.log(config.get('awesome'));
//=> undefined

Returns a new instance.

Type: string

Name of your package.

Type: object

Default config.

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.

Type: string
Default: Automatic

Please don't use this option unless absolutely necessary and you know what you're doing.

Set the path of the config file. Overrides the packageName and globalConfigPath options.

Type: boolean
Default: true

Clear the config file if it contains invalid JSON. If set to false, a SyntaxError will be thrown instead of clearing the file. This allows you to recover corrupted config files manually.

You can use dot-notation in a key to access nested properties.

Set an item.

You can use dot-notation in a key to access nested properties.

Set multiple items at once.

Get an item.

You can use dot-notation in a key to access nested properties.

const value = config.get('key') ?? 'default value';

Check if an item exists.

You can use dot-notation in a key to access nested properties.

Delete an item.

You can use dot-notation in a key to access nested properties.

Delete all items.

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.

Get all the config as an object or replace the current config with an object:

config.all = {
	hello: 'world'
};