configstore
Advanced tools
Package description
The configstore npm package is used for easily loading and persisting config without having to think about where and how. It's ideal for storing user settings, application configurations, and other data that needs to be saved between sessions.
Creating and managing a config store
This code demonstrates how to create a new config store associated with a specific package and set default values. It also shows how to retrieve a value from the store.
const Configstore = require('configstore');
const packageJson = require('./package.json');
const conf = new Configstore(packageJson.name, {foo: 'bar'});
console.log(conf.get('foo'));
//=> 'bar'Setting and getting data
This code shows how to set and get data in the config store. It also demonstrates the use of dot-notation to work with nested properties.
conf.set('awesome', true);
console.log(conf.get('awesome'));
//=> true
// Using dot-notation for nested properties
conf.set('bar.baz', true);
console.log(conf.get('bar'));
//=> { baz: true }Deleting data
This code snippet illustrates how to delete a key-value pair from the config store.
conf.delete('awesome');
console.log(conf.get('awesome'));
//=> undefinedAccessing the entire store
This code example shows how to access the entire config store, which returns an object containing all the key-value pairs.
console.log(conf.all);
//=> { foo: 'bar', bar: { baz: true } }Checking if a key exists
This code demonstrates how to check if a particular key exists in the config store.
console.log(conf.has('foo'));
//=> trueThe 'rc' package is similar to configstore in that it handles configuration for Node.js applications. It reads from a variety of sources including command-line arguments, environment variables, and configuration files. Unlike configstore, 'rc' does not provide an API for setting or deleting configuration values programmatically.
The 'dotenv' package is used to load environment variables from a .env file into process.env. It is similar to configstore in that it helps manage application configuration. However, 'dotenv' is focused on environment variables and does not provide a direct API for setting, getting, or persisting data.
The 'nconf' package is a hierarchical node.js configuration with files, environment variables, command-line arguments, and atomic object merging. It provides a rich API for managing configuration data, similar to configstore, but with a focus on a hierarchical structure and multiple configuration sources.
Readme
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 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}
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.
You can use dot-notation in a key to access nested properties.
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 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'
};
FAQs
Easily load and save config without having to think about where and how
The npm package configstore receives a total of 6,830,157 weekly downloads. As such, configstore popularity was classified as popular.
We found that configstore demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 9 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.
Security News
GitHub is susceptible to a CDN flaw that allows attackers to host malware on any public repository.