node package manager

conf

Simple config handling for your app or module

conf

Simple config handling for your app or module

All you have to care about is what to persist. This module will handle all the dull details like where and how.

$ npm install --save conf
const Conf = require('conf');
const config = new Conf();
 
config.set('unicorn', '🦄');
console.log(config.get('unicorn'));
//=> '🦄' 
 
// use dot-notation to access nested properties 
config.set('foo.bar', true);
console.log(config.get('foo'));
//=> {bar: true} 
 
config.delete('unicorn');
console.log(config.get('unicorn'));
//=> undefined 

Or create a subclass.

Returns a new instance.

Type: Object

Default config.

Type: string
Default: config

Name of the config file (without extension).

Useful if you need multiple config files for your app or module. For example, different config files between two major versions.

Type: string
Default: The name field in your package.json

You only need to specify this if you don't have a package.json file in your project.

Type: string
Default: System default user config directory

You most likely don't need this.

Overrides projectName.

The only use-case I can think of is having the config located in the app directory or on some external storage.

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

The instance is iterable so you can use it directly in a for…of loop.

Set an item.

Set multiple items at once.

Get an item.

Check if an item exists.

Delete an item.

Delete all items.

Get the item count.

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

conf.store = {
    hello: 'world'
};

Get the path to the config file.

How is this different from configstore?

I'm also the author of configstore. While it's pretty good, I did make some mistakes early on that are hard to change at this point. This module is the result of everything I learned from making configstore. Mainly where config is stored. In configstore, the config is stored in ~/.config (which is mainly a Linux convention) on all systems, while conf stores config in the system default user config directory. The ~/.config directory, it turns out, often have an incorrect permission on macOS and Windows, which has caused a lot of grief for users.

MIT © Sindre Sorhus