Security News
NIST Misses 2024 Deadline to Clear NVD Backlog
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.
configstore
Advanced tools
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'));
//=> undefined
Accessing 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'));
//=> true
The '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.
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.
Set multiple items at once.
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
FAQs
Easily load and save config without having to think about where and how
The npm package configstore receives a total of 5,337,917 weekly downloads. As such, configstore popularity was classified as popular.
We found that configstore demonstrated a healthy version release cadence and project activity because the last version was released less than 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
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.
Security News
Cloudflare has launched a setup wizard allowing users to easily create and manage a security.txt file for vulnerability disclosure on their websites.
Security News
The Socket Research team breaks down a malicious npm package targeting the legitimate DOMPurify library. It uses obfuscated code to hide that it is exfiltrating browser and crypto wallet data.