Configstore

https://www.npmjs.com/package/configstore
Admin
Configstore is a simple library for easily loading and persisting configuration data as JSON files...
Tokens:4,702
Snippets:77
Trust Score:9.6
Update:6 months ago
Show doc for...
Tokens:
Raw
### Usage Example

Source: https://www.npmjs.com/package/configstore?activeTab=readme

Demonstrates basic usage of Configstore for setting, getting, and deleting configuration values.

```APIDOC
## Usage
```javascript
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}

// Handle missing keys with nullish coalescing.
console.log(config.get('nonexistent') ?? 'default value');
//=> 'default value'

config.delete('awesome');
console.log(config.get('awesome'));
//=> undefined
```
```

--------------------------------

### Usage Example

Source: https://www.npmjs.com/package/configstore?activeTab=versions

A practical example demonstrating how to use Configstore to manage application settings.

```APIDOC
## Usage
```
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}

// Handle missing keys with nullish coalescing.
console.log(config.get('nonexistent') ?? 'default value');
//=> 'default value'

config.delete('awesome');
console.log(config.get('awesome'));
//=> undefined
```
```

--------------------------------

### Installation

Source: https://www.npmjs.com/package/configstore?activeTab=dependents

Install the configstore package using npm.

```APIDOC
## Install
```
npm install configstore
```
```

--------------------------------

### Install Configstore

Source: https://www.npmjs.com/package/configstore?activeTab=dependencies

Command to install the package via npm.

```bash
npm install configstore
```

--------------------------------

### Basic Usage and Configuration Management

Source: https://www.npmjs.com/package/configstore?activeTab=dependencies

Demonstrates initializing a Configstore instance, setting and retrieving values, using dot-notation for nested properties, and handling missing keys.

```javascript
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}

// Handle missing keys with nullish coalescing.
console.log(config.get('nonexistent') ?? 'default value');
//=> 'default value'

config.delete('awesome');
console.log(config.get('awesome'));
//=> undefined
```

--------------------------------

### Instance Methods

Source: https://www.npmjs.com/package/configstore?activeTab=dependents

Methods available on a Configstore instance.

```APIDOC
### Instance Methods

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

#### .set(key, value)

Set an item. You can use dot-notation in a `key` to access nested properties.

#### .set(object)

Set multiple items at once.

#### .get(key)

Get an item. You can use dot-notation in a `key` to access nested properties.

> Use the nullish coalescing operator (`??`) to provide default values:
> ```javascript
> const value = config.get('key') ?? 'default value';
> ```

#### .has(key)

Check if an item exists. You can use dot-notation in a `key` to access nested properties.

#### .delete(key)

Delete an item. You can use dot-notation in a `key` to access nested properties.

#### .clear()

Delete all items.

#### .size

Get the item count.

#### .path

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.

#### .all

Get all the config as an object or replace the current config with an object.
```javascript
console.log(config.all);
//=> {foo: 'bar', hello: 'world'}

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

--------------------------------

### Access and Replace All Configuration

Source: https://www.npmjs.com/package/configstore?activeTab=dependencies

Demonstrates how to retrieve the entire configuration object or overwrite it entirely.

```javascript
console.log(config.all);
//=> {foo: 'bar', hello: 'world'}

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

--------------------------------

### Configstore Constructor

Source: https://www.npmjs.com/package/configstore?activeTab=versions

Initialize a new Configstore instance with an identifier and optional defaults or options.

```APIDOC
## API
### Configstore(id, defaults?, options?)
Returns a new instance.
#### id
Type: `string`
Identifier for your config. Usually your package name.
#### defaults
Type: `object`
Default config.
#### options
Type: `object`
##### globalConfigPath
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.
##### configPath
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 `id` and `globalConfigPath` options.
##### clearInvalidConfig
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.
```

--------------------------------

### Instance Methods

Source: https://www.npmjs.com/package/configstore?activeTab=readme

Methods available on a Configstore instance for managing configuration data.

```APIDOC
### Instance
You can use dot-notation in a `key` to access nested properties.
### .set(key, value)
Set an item.
You can use dot-notation in a `key` to access nested properties.
### .set(object)
Set multiple items at once.
### .get(key)
Get an item.
You can use dot-notation in a `key` to access nested properties.
> [!TIP] Use the nullish coalescing operator (`??`) to provide default values:
> ```javascript
const value = config.get('key') ?? 'default value';
```

### .has(key)
Check if an item exists.
You can use dot-notation in a `key` to access nested properties.
### .delete(key)
Delete an item.
You can use dot-notation in a `key` to access nested properties.
### .clear()
Delete all items.
### .size
Get the item count.
### .path
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.
### .all
Get all the config as an object or replace the current config with an object.
```javascript
console.log(config.all);
//=> {foo: 'bar', hello: 'world'}

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

--------------------------------

### Instance Methods

Source: https://www.npmjs.com/package/configstore?activeTab=versions

Methods available on a Configstore instance for managing configuration data.

```APIDOC
### Instance
You can use dot-notation in a `key` to access nested properties.
### .set(key, value)
Set an item.
You can use dot-notation in a `key` to access nested properties.
### .set(object)
Set multiple items at once.
### .get(key)
Get an item.
You can use dot-notation in a `key` to access nested nested properties.
> [!TIP] Use the nullish coalescing operator (`??`) to provide default values:
> ```
const value = config.get('key') ?? 'default value';
```

### .has(key)
Check if an item exists.
You can use dot-notation in a `key` to access nested properties.
### .delete(key)
Delete an item.
You can use dot-notation in a `key` to access nested properties.
### .clear()
Delete all items.
```

--------------------------------

### Configstore Constructor

Source: https://www.npmjs.com/package/configstore?activeTab=dependencies

Initializes a new Configstore instance to manage configuration data.

```APIDOC
## Configstore(id, defaults?, options?)

### Description
Returns a new instance of Configstore.

### Parameters
- **id** (string) - Required - Identifier for your config, usually your package name.
- **defaults** (object) - Optional - Default configuration object.
- **options** (object) - Optional - Configuration options.
  - **globalConfigPath** (boolean) - Optional - Store config at $CONFIG/package-name/config.json.
  - **configPath** (string) - Optional - Manually set the path of the config file.
  - **clearInvalidConfig** (boolean) - Optional - Clear the config file if it contains invalid JSON.
```

--------------------------------

### Configstore Instance Methods

Source: https://www.npmjs.com/package/configstore?activeTab=dependencies

Methods for interacting with the configuration data stored in the instance.

```APIDOC
## Instance Methods

### .set(key, value)
Set an item. Supports dot-notation for nested properties.

### .set(object)
Set multiple items at once.

### .get(key)
Get an item. Supports dot-notation for nested properties.

### .has(key)
Check if an item exists. Supports dot-notation for nested properties.

### .delete(key)
Delete an item. Supports dot-notation for nested properties.

### .clear()
Delete all items.

### .size
Get the item count.

### .path
Get the path to the config file.

### .all
Get all the config as an object or replace the current config with an object.
```

--------------------------------

### Instance Properties

Source: https://www.npmjs.com/package/configstore?activeTab=versions

Properties available on a Configstore instance.

```APIDOC
### .size
Get the item count.
### .path
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.
### .all
Get all the config as an object or replace the current config with an object.
```
console.log(config.all);
//=> {foo: 'bar', hello: 'world'}

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

--------------------------------

### Provide Default Values with Nullish Coalescing

Source: https://www.npmjs.com/package/configstore?activeTab=dependencies

Recommended pattern for providing fallback values when a key is missing.

```javascript
const value = config.get('key') ?? 'default value';
```
Tokens:
Raw