conf
- Version 16.0.0
- Published
- 200 kB
- 9 dependencies
- MIT license
Install
npm i confyarn add confpnpm add confOverview
Simple config handling for your app or module
Index
Classes
class Conf
class Conf<T extends Record<string, any> = Record<string, unknown>> implements Iterable<[keyof T, T[keyof T]]> {}constructor
constructor(partialOptions?: Readonly<Partial<Options<T>>>);property events
readonly events: EventTarget;Dispatches a
changeevent on every write of this instance, and when thewatchoption reports a change to the config file.onDidChange()andonDidAnyChange()listen on it, and you can also listen to it directly.
property path
readonly path: string;Get the path to the config file.
property size
readonly size: number;Get the item count.
property store
store: Record<string, any>;Get all the config as an object or replace the current config with an object.
Example 1
``` console.log(config.store); //=> [Object: null prototype] {name: 'John', age: 30} ```
Unlike
set(), a whole-store write drops a function or a symbol, likeJSON.stringifydoes, instead of throwing. Abigintstill throws, unless you use a customserialize.Example 2
``` config.store = { hello: 'world' }; ```
method [Symbol.iterator]
[Symbol.iterator]: () => IterableIterator<[keyof T, T[keyof T]]>;method appendToArray
appendToArray: { <Key extends keyof T>(key: Key, value: ArrayItemsOf<T[Key]>): void; < Key extends { [K in keyof Required<T>]: K extends string ? Required<T>[K] extends OpaqueValue ? K : Required<T>[K] extends Record<string, any> ? | K | `${K}.${{ [K in keyof Required< Required<T>[K] >]: K extends string ? Required< Required<T>[K] >[K] extends OpaqueValue ? K : Required< Required<T>[K] >[K] extends Record<string, any> ? | K | `${K}.${{ [K in keyof Required< Required< Required<T>[K] >[K] >]: K extends string ? Required< Required< Required<T>[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required<T>[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required<T>[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required<T>[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required<T>[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? K : K : never; }[keyof Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required< Required<T>[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required<T>[K] >[K] >[K]]}` : K : never; }[keyof Required< Required<T>[K] >[K]]}` : K : never; }[keyof Required<T>[K]]}` : K : never; }[keyof T] >( key: Key, value: ArrayItemsOf<DotNotationValueOf<T, Key>> ): void;};Append an item to an array.
If the key doesn't exist, it will be created as an array. If the key exists and is not an array, a
TypeErrorwill be thrown.The
valuemust be JSON serializable. Trying to set a value of typeundefined,function, orsymbolwill result in aTypeError, and so will abigintunless you use a customserialize.Parameter key
The key of the array to append to. You can use [dot-notation](https://github.com/sindresorhus/dot-prop) to access nested properties.
Parameter value
The item to append. Must be JSON serializable.
Example 1
``` config.set('items', [{name: 'foo'}]); config.appendToArray('items', {name: 'bar'}); console.log(config.get('items')); //=> [{name: 'foo'}, {name: 'bar'}]
// Creates array if key doesn't exist config.appendToArray('newItems', 'first'); console.log(config.get('newItems')); //=> ['first'] ```
method clear
clear: () => void;Delete all items.
This resets known items to their default values, if defined by the
defaultsorschemaoption. Thedefaultvalues of theschemaoption are not used whenajvOptions.useDefaultsisfalse.
method delete
delete: { <Key extends keyof T>(key: Key): void; < Key extends { [K in keyof Required<T>]: K extends string ? Required<T>[K] extends OpaqueValue ? K : Required<T>[K] extends Record<string, any> ? | K | `${K}.${{ [K in keyof Required< Required<T>[K] >]: K extends string ? Required< Required<T>[K] >[K] extends OpaqueValue ? K : Required< Required<T>[K] >[K] extends Record<string, any> ? | K | `${K}.${{ [K in keyof Required< Required< Required<T>[K] >[K] >]: K extends string ? Required< Required< Required<T>[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required<T>[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required<T>[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required<T>[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required<T>[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? K : K : never; }[keyof Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required< Required<T>[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required<T>[K] >[K] >[K]]}` : K : never; }[keyof Required< Required<T>[K] >[K]]}` : K : never; }[keyof Required<T>[K]]}` : K : never; }[keyof T] >( key: Key ): void;};Delete an item.
Parameter key
The key of the item to delete.
method get
get: { <Key extends keyof T>(key: Key): T[Key]; <Key extends keyof T>( key: Key, defaultValue: Exclude<T[Key], undefined> ): Exclude<T[Key], undefined>; < Key extends { [K in keyof Required<T>]: K extends string ? Required<T>[K] extends OpaqueValue ? K : Required<T>[K] extends Record<string, any> ? | K | `${K}.${{ [K in keyof Required< Required<T>[K] >]: K extends string ? Required< Required<T>[K] >[K] extends OpaqueValue ? K : Required< Required<T>[K] >[K] extends Record<string, any> ? | K | `${K}.${{ [K in keyof Required< Required< Required<T>[K] >[K] >]: K extends string ? Required< Required< Required<T>[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required<T>[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required<T>[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required<T>[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required<T>[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? K : K : never; }[keyof Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required< Required<T>[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required<T>[K] >[K] >[K]]}` : K : never; }[keyof Required< Required<T>[K] >[K]]}` : K : never; }[keyof Required<T>[K]]}` : K : never; }[keyof T] >( key: Key ): DotNotationValueOf<T, Key>; < Key extends { [K in keyof Required<T>]: K extends string ? Required<T>[K] extends OpaqueValue ? K : Required<T>[K] extends Record<string, any> ? | K | `${K}.${{ [K in keyof Required< Required<T>[K] >]: K extends string ? Required< Required<T>[K] >[K] extends OpaqueValue ? K : Required< Required<T>[K] >[K] extends Record<string, any> ? | K | `${K}.${{ [K in keyof Required< Required< Required<T>[K] >[K] >]: K extends string ? Required< Required< Required<T>[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required<T>[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required<T>[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required<T>[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required<T>[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? K : K : never; }[keyof Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required< Required<T>[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required<T>[K] >[K] >[K]]}` : K : never; }[keyof Required< Required<T>[K] >[K]]}` : K : never; }[keyof Required<T>[K]]}` : K : never; }[keyof T] >( key: Key, defaultValue: Exclude<DotNotationValueOf<T, Key>, undefined> ): Exclude<DotNotationValueOf<T, Key>, undefined>; <Key extends string, Value = unknown>( key: Exclude< Key, { [K in keyof Required<T>]: K extends string ? Required<T>[K] extends OpaqueValue ? K : Required<T>[K] extends Record<string, any> ? | K | `${K}.${{ [K in keyof Required< Required<T>[K] >]: K extends string ? Required< Required<T>[K] >[K] extends OpaqueValue ? K : Required< Required<T>[K] >[K] extends Record<string, any> ? | K | `${K}.${{ [K in keyof Required< Required< Required<T>[K] >[K] >]: K extends string ? Required< Required< Required<T>[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required<T>[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required<T>[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required<T>[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required<T>[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? K : K : never; }[keyof Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required< Required<T>[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required<T>[K] >[K] >[K]]}` : K : never; }[keyof Required< Required<T>[K] >[K]]}` : K : never; }[keyof Required<T>[K]]}` : K : never; }[keyof T] >, defaultValue?: Value ): Value;};Get an item.
Parameter key
The key of the item to get.
Parameter defaultValue
The default value if the item does not exist.
Tip: To get all items, see
.store.
method has
has: { <Key extends keyof T>(key: Key): boolean; < Key extends { [K in keyof Required<T>]: K extends string ? Required<T>[K] extends OpaqueValue ? K : Required<T>[K] extends Record<string, any> ? | K | `${K}.${{ [K in keyof Required< Required<T>[K] >]: K extends string ? Required< Required<T>[K] >[K] extends OpaqueValue ? K : Required< Required<T>[K] >[K] extends Record<string, any> ? | K | `${K}.${{ [K in keyof Required< Required< Required<T>[K] >[K] >]: K extends string ? Required< Required< Required<T>[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required<T>[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required<T>[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required<T>[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required<T>[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? K : K : never; }[keyof Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required< Required<T>[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required<T>[K] >[K] >[K]]}` : K : never; }[keyof Required< Required<T>[K] >[K]]}` : K : never; }[keyof Required<T>[K]]}` : K : never; }[keyof T] >( key: Key ): boolean;};Check if an item exists.
Parameter key
The key of the item to check.
method onDidAnyChange
onDidAnyChange: (callback: OnDidAnyChangeCallback<T>) => Unsubscribe;Watches the whole config object, calling
callbackon any changes.A change noticed while the config file cannot be read, for example while another process is writing it, is not reported.
oldValueandnewValuewill be the config object before and after the change, respectively. You must compareoldValuetonewValueto find out what changed.Parameter callback
A callback function that is called on any changes.
Returns
A function that unsubscribes when called.
Example 1
``` const unsubscribe = config.onDidAnyChange(callback);
unsubscribe(); ```
method onDidChange
onDidChange: { <Key extends keyof T>( key: Key, callback: OnDidChangeCallback<T[Key]> ): Unsubscribe; < Key extends { [K in keyof Required<T>]: K extends string ? Required<T>[K] extends OpaqueValue ? K : Required<T>[K] extends Record<string, any> ? | K | `${K}.${{ [K in keyof Required< Required<T>[K] >]: K extends string ? Required< Required<T>[K] >[K] extends OpaqueValue ? K : Required< Required<T>[K] >[K] extends Record<string, any> ? | K | `${K}.${{ [K in keyof Required< Required< Required<T>[K] >[K] >]: K extends string ? Required< Required< Required<T>[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required<T>[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required<T>[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required<T>[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required<T>[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? K : K : never; }[keyof Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required< Required<T>[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required<T>[K] >[K] >[K]]}` : K : never; }[keyof Required< Required<T>[K] >[K]]}` : K : never; }[keyof Required<T>[K]]}` : K : never; }[keyof T] >( key: Key, callback: OnDidChangeCallback<DotNotationValueOf<T, Key>> ): Unsubscribe;};Watches the given
key, callingcallbackon any changes.A change noticed while the config file cannot be read, for example while another process is writing it, is not reported.
Parameter key
The key to watch.
Parameter callback
A callback function that is called on any changes. When a key is first set,
oldValuewill beundefined, and when a key is deleted,newValuewill beundefined.Returns
A function that unsubscribes when called.
Example 1
``` const unsubscribe = config.onDidChange(key, callback);
unsubscribe(); ```
method reset
reset: { <Key extends keyof T>(...keys: Key[]): void; < Key extends { [K in keyof Required<T>]: K extends string ? Required<T>[K] extends OpaqueValue ? K : Required<T>[K] extends Record<string, any> ? | K | `${K}.${{ [K in keyof Required< Required<T>[K] >]: K extends string ? Required< Required<T>[K] >[K] extends OpaqueValue ? K : Required< Required<T>[K] >[K] extends Record<string, any> ? | K | `${K}.${{ [K in keyof Required< Required< Required<T>[K] >[K] >]: K extends string ? Required< Required< Required<T>[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required<T>[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required<T>[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required<T>[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required<T>[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? K : K : never; }[keyof Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required< Required<T>[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required<T>[K] >[K] >[K]]}` : K : never; }[keyof Required< Required<T>[K] >[K]]}` : K : never; }[keyof Required<T>[K]]}` : K : never; }[keyof T] >( ...keys: Key[] ): void;};Reset items to their default values, as defined by the
defaultsorschemaoption. Thedefaultvalues of theschemaoption are not used whenajvOptions.useDefaultsisfalse.With dot notation, schema defaults below an optional object with no default of its own are unavailable to
reset()when a parent default omits that object. Include the object in the parent default to reset its descendants individually.Parameter keys
The keys of the items to reset.
See Also
clear()to reset all items.
method set
set: { <Key extends keyof T>(key: Key, value: Exclude<T[Key], undefined>): void; < Key extends { [K in keyof Required<T>]: K extends string ? Required<T>[K] extends OpaqueValue ? K : Required<T>[K] extends Record<string, any> ? | K | `${K}.${{ [K in keyof Required< Required<T>[K] >]: K extends string ? Required< Required<T>[K] >[K] extends OpaqueValue ? K : Required< Required<T>[K] >[K] extends Record<string, any> ? | K | `${K}.${{ [K in keyof Required< Required< Required<T>[K] >[K] >]: K extends string ? Required< Required< Required<T>[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required<T>[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required<T>[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required<T>[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required<T>[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? K : K : never; }[keyof Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required< Required<T>[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required<T>[K] >[K] >[K]]}` : K : never; }[keyof Required< Required<T>[K] >[K]]}` : K : never; }[keyof Required<T>[K]]}` : K : never; }[keyof T] >( key: Key, value: Exclude<DotNotationValueOf<T, Key>, undefined> ): void; <Key extends string>( key: Key & (string extends Key ? Key : Exclude< Key, { [K in keyof Required<T>]: K extends string ? Required<T>[K] extends OpaqueValue ? K : Required<T>[K] extends Record<string, any> ? | K | `${K}.${{ [K in keyof Required< Required<T>[K] >]: K extends string ? Required< Required<T>[K] >[K] extends OpaqueValue ? K : Required< Required<T>[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required<T>[K] >[K] >]: K extends string ? Required< Required< Required<T>[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required<T>[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required<T>[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required<T>[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required<T>[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? | K | `${K}.${{ [K in keyof Required< Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >]: K extends string ? Required< Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends OpaqueValue ? K : Required< Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] extends Record< string, any > ? K : K : never; }[keyof Required< Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required< Required< Required<T>[K] >[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required< Required<T>[K] >[K] >[K] >[K]]}` : K : never; }[keyof Required< Required< Required<T>[K] >[K] >[K]]}` : K : never; }[keyof Required< Required<T>[K] >[K]]}` : K : never; }[keyof Required<T>[K]]}` : K : never; }[keyof T] >), value: unknown ): void; (object: DefaultsOf<T>): void;};Set an item or multiple items at once.
Parameter key
The key of the item to set. You can use [dot-notation](https://github.com/sindresorhus/dot-prop) in a key to access nested properties. Or an object of items to set at once, where each key replaces the whole value it names, and with dot notation a key can be a path, such as
{'foo.bar': 1}.Parameter value
Must be JSON serializable. Trying to set a value of type
undefined,function, orsymbolwill result in aTypeError, and so will abigintunless you use a customserialize.
Type Aliases
type Options
type Options<T extends Record<string, any>> = { /** Default values for the config items.
**Note:** The values in `defaults` will overwrite the `default` key in the `schema` option.
**Note:** The values are copied when the store is created, so changing the object you passed afterwards has no effect. A value with a `toJSON` method, such as a `Date`, is stored as what it serializes to.
**Note:** A key covered by `defaults` cannot be deleted, since the default is written back. With dot notation, a key below it can be deleted, and `reset()` puts it back.
**Note:** A value must be JSON serializable, like for `set()`. A key set to `undefined` is ignored. */ defaults?: Readonly<DefaultsOf<T>>; /** [JSON Schema](https://json-schema.org) to validate your config data.
This will be the [`properties`](https://json-schema.org/understanding-json-schema/reference/object.html#properties) object of the JSON schema. That is, define `schema` as an object where each key is the name of your data's property and each value is a JSON schema used to validate that property.
**Note:** The ajv dependency may cause CSP violations. See the readme FAQ: Can I use `conf` with strict Content Security Policy (CSP)?
@example ``` import Conf from 'conf';
const schema = { foo: { type: 'number', maximum: 100, minimum: 1, default: 50 }, bar: { type: 'string', format: 'url' } };
const config = new Conf({ projectName: 'foo', schema });
console.log(config.get('foo')); //=> 50
config.set('foo', '1'); // [Error: Config schema violation: `foo` must be number] ```
**Note:** The `default` value will be overwritten by the `defaults` option if set.
**Note:** A `default` must be JSON serializable, like a `set()` value. With dot notation, a `schema` key must be a plain property name, so describe nested keys with `properties`. A name inside `properties` can contain a dot, such as `example.com`. Escape the dot to read or write it, such as `sites.example\.com` (in JavaScript, `'sites.example\\.com'`).
To have `get()` return the right types, annotate the schema with `Schema<T>`:
@example ``` import Conf, {type Schema} from 'conf';
type Store = { isEnabled: boolean; interval: number; };
const schema: Schema<Store> = { isEnabled: {type: 'boolean'}, interval: {type: 'number'} };
const config = new Conf({projectName: 'foo', schema});
console.log(config.get('isEnabled')); //=> typed as boolean ```
Without the annotation, TypeScript cannot tell the value types from the schema, so `get()` returns `unknown`. If you also pass `defaults`, the schema still wins the inference, so a key that is only in `defaults` is an error. */ schema?: Schema<T>; /** Root-level [JSON Schema keywords](https://json-schema.org/understanding-json-schema/reference) for the schema, such as `additionalProperties` or `patternProperties`. This is useful when you do not know the key names in advance.
The `properties` keyword comes from the `schema` option. Do not put `properties` in `rootSchema`, as it will throw.
@example ``` import Conf from 'conf';
const store = new Conf({ projectName: 'foo', schema: {}, rootSchema: { additionalProperties: false } }); ```
@example ``` import Conf from 'conf';
const store = new Conf({ projectName: 'foo', rootSchema: { patternProperties: { '^.*$': { type: 'object', properties: { schedule: {type: 'string'} } } } } }); ``` */ rootSchema?: RootSchema; /** [Options passed to AJV](https://ajv.js.org/options.html).
Under the hood, the JSON Schema validator [ajv](https://ajv.js.org/json-schema.html) is used to validate your config. We use [JSON Schema draft-2020-12](https://json-schema.org/draft/2020-12/release-notes) and support all validation keywords and formats.
**Note:** By default, `allErrors` and `useDefaults` are both set to `true`, but can be overridden.
@example ``` import Conf from 'conf';
const store = new Conf({ projectName: 'foo', schema: {}, rootSchema: { additionalProperties: false }, ajvOptions: { removeAdditional: true } }); ``` */ ajvOptions?: AjvOptions; /** Name of the config file (without extension).
It may include a subdirectory of `cwd`, such as `sub/config`, but it must not point outside `cwd`.
Useful if you need multiple config files for your app or module. For example, different config files between two major versions.
@default 'config' */ configName?: string; /** __Required unless you specify the `cwd` option.__
You can fetch the `name` field from package.json:
@example ``` import Conf from 'conf'; import packageJson from './package.json' with {type: 'json'};
const config = new Conf({projectName: packageJson.name}); ``` */ projectName?: string; /** __Required if you specify the `migrations` option.__
You can fetch the `version` field from package.json.
With `migrations`, it must be a full semantic version, such as `1.0.0`. */ projectVersion?: string; /** **Important: I cannot provide support for this feature. It has some known bugs. I have no plans to work on it, but pull requests are welcome.**
You can use migrations to perform operations to the store whenever a **project version** is upgraded.
The `migrations` object should consist of key-value pairs of `'version': handler`. The `version` can also be a [semver range](https://github.com/npm/node-semver#ranges). Migrations run in version order, whatever order they are defined in.
A migration must not create another `Conf` instance with `migrations` for the same config file.
A migration sees the keys the config file holds and the values of the `defaults` option. The `default` values of the `schema` option are added after the migrations have run, since a migration may repair a value the schema rejects.
The store keeps its migration bookkeeping in the config file under a reserved `__internal__` key. It is not exposed through `.store`, `.get()`, `.has()` or iteration, and `.set()` and `.delete()` reject it.
The recorded version never moves backwards, so running an older `projectVersion` than the store was migrated with does not run those migrations again.
Migrations do not run for a config file that does not exist yet. There is no old data to migrate, so the store starts at the current project version. A config file that exists but has no recorded version is still migrated, which covers an app that shipped before it had migrations.
@example ``` import Conf from 'conf';
const store = new Conf({ projectName: 'foo', projectVersion: '2.0.0', migrations: { '0.0.1': store => { store.set('debugPhase', true); }, '1.0.0': store => { store.delete('debugPhase'); store.set('phase', '1.0.0'); }, '1.0.2': store => { store.set('phase', '1.0.2'); }, '>=2.0.0': store => { store.set('phase', '>=2.0.0'); } } }); ```
**Note:** The migration versions are compared with the `projectVersion` option.
If a migration throws, the changes it made are rolled back, and an error that includes its message is thrown. The migrations before it are kept. */ migrations?: Migrations<T>; /** The given callback function will be called before each migration step.
The function receives the store as the first argument and a context object as the second argument with the following properties:
- `fromVersion` - The version the migration step is being migrated from. - `toVersion` - The version the migration step is being migrated to. For a range, this is the version it runs at. - `finalVersion` - The final version after all the migrations are applied. - `versions` - The versions that will run in this migration pass.
This can be useful for logging purposes, preparing migration data, etc.
@default undefined
@example ``` import Conf from 'conf';
console.log = someLogger.log;
// Migrations do not run for a config file that does not exist yet, so these log for an app that has run before.
const mainConfig = new Conf({ projectName: 'foo1', projectVersion: '0.4.0', beforeEachMigration: (store, context) => { console.log(`[main-config] migrate from ${context.fromVersion} → ${context.toVersion}`); }, migrations: { '0.4.0': store => { store.set('debugPhase', true); }, } });
const secondConfig = new Conf({ projectName: 'foo2', projectVersion: '1.0.1', beforeEachMigration: (store, context) => { console.log(`[second-config] migrate from ${context.fromVersion} → ${context.toVersion}`); }, migrations: { '1.0.1': store => { store.set('debugPhase', true); }, } }); ``` */ beforeEachMigration?: BeforeEachMigrationCallback<T>; /** __You most likely don't need this. Please don't use it unless you really have to. By default, it will pick the optimal location by adhering to system conventions. You are very likely to get this wrong and annoy users.__
Default: System default user [config directory](https://github.com/sindresorhus/env-paths#pathsconfig).
Overrides `projectName`.
By default the config is stored in the [system user's config directory](https://github.com/sindresorhus/env-paths#pathsconfig); running under another user reads a different store. Set `cwd` to share across users.
The only use case I can think of is having the config located in the app directory or on some external storage. */ cwd?: string; /** Note that this is __not intended for security purposes__, since the encryption key would be easily found inside a plaintext Node.js app.
Its main use is for obscurity. If a user looks through the config directory and finds the config file, since it's just a JSON file, they may be tempted to modify it. By providing an encryption key, the file will be obfuscated, which should hopefully deter any users from doing so.
When using `aes-256-gcm`, the config file is authenticated. If the file is changed in any way, the decryption will fail. With `aes-256-cbc` and `aes-256-ctr`, tampering can go undetected.
When specified, the store will be encrypted using the `encryptionAlgorithm` option (defaults to `aes-256-cbc`). An empty string is refused.
@default undefined */ encryptionKey?: string | Uint8Array | NodeJS.TypedArray | DataView; /** Encryption algorithm to use when `encryptionKey` is set.
Use `aes-256-gcm` if you want authentication, otherwise use `aes-256-cbc` or `aes-256-ctr`.
Changing `encryptionAlgorithm` will make existing encrypted data unreadable.
When using `aes-256-gcm` or `aes-256-ctr`, existing plaintext config files are not supported. Delete the config file or migrate it before enabling encryption. With `aes-256-cbc`, existing plaintext config files are still readable for backward compatibility.
@default 'aes-256-cbc' */ encryptionAlgorithm?: 'aes-256-cbc' | 'aes-256-gcm' | 'aes-256-ctr'; /** Extension of the config file.
You would usually not need this, but it could be useful if you want to interact with a file with a custom file extension that can be associated with your app. These might be simple save/export/preference files that are intended to be shareable or saved outside of the app.
@default 'json' */ fileExtension?: string; /** The config is cleared if reading the config file causes a `SyntaxError` (malformed JSON, also when thrown by your own `deserialize`), a schema validation error when using the `schema` option, or a decryption failure when using `encryptionKey`, and the cleared store is written over the file. This is a good behavior for unimportant data, as the config file is not intended to be hand-edited, so it usually means the config is corrupt and there's nothing the user can do about it anyway. However, if you let the user edit the config file directly, mistakes might happen and it could be more useful to throw an error when the config is invalid instead of clearing.
A decryption failure includes a changed `encryptionKey` or `encryptionAlgorithm`, and a plaintext config file read with the `aes-256-gcm` or `aes-256-ctr` algorithm (for example, after adding encryption to an existing store). With your own `deserialize` and the `aes-256-cbc` or `aes-256-ctr` algorithm, a changed `encryptionKey` or `encryptionAlgorithm` is cleared only when your `deserialize` throws a `SyntaxError` for the data it cannot read, since those algorithms cannot tell a wrong key apart from damaged data. Any other error thrown by your own `deserialize` is thrown as is.
@default false */ clearInvalidConfig?: boolean; /** Function to serialize the config object to a UTF-8 string, or to a `Uint8Array`, when writing the config file.
You would usually not need this, but it could be useful if you want to use a format other than JSON.
@default value => JSON.stringify(value, null, '\t') */ readonly serialize?: Serialize<T>; /** Function to deserialize the config object from a UTF-8 string when reading the config file.
You would usually not need this, but it could be useful if you want to use a format other than JSON.
@default `JSON.parse`, ignoring a leading byte order mark */ readonly deserialize?: Deserialize<T>; /** __You most likely don't need this. Please don't use it unless you really have to.__
Suffix appended to `projectName` during config file creation to avoid name conflicts with native apps.
You can pass an empty string to remove the suffix.
For example, on macOS, the config file will be stored in the `~/Library/Preferences/foo-nodejs` directory, where `foo` is the `projectName`.
@default 'nodejs' */ readonly projectSuffix?: string; /** Access nested properties by dot notation. For example:
@default true
@example ``` import Conf from 'conf';
const config = new Conf({projectName: 'foo'});
config.set({ foo: { bar: { foobar: '🦄' } } });
console.log(config.get('foo.bar.foobar')); //=> '🦄' ```
Alternatively, you can set this option to `false` so the whole string is treated as one key.
@example ``` import Conf from 'conf';
const config = new Conf({ projectName: 'foo', accessPropertiesByDotNotation: false });
config.set({ 'foo.bar.foobar': '🦄' });
console.log(config.get('foo.bar.foobar')); //=> '🦄' ```
With this option on, `__proto__`, `constructor` and `prototype` cannot be used in a key: `set()` ignores such a key, `get()` returns the default value for it, and the `defaults` and `schema` options throw for it. Set this option to `false` to use them as keys.
A key that is not a valid path, such as `a[x`, throws a `TypeError`. */ readonly accessPropertiesByDotNotation?: boolean; /** Watch for any changes in the config file and call the callback for `onDidChange` or `onDidAnyChange` if set. This is useful if there are multiple processes changing the same config file.
If the config file is a symlink, the file it points to when the store is created is watched.
@default false */ readonly watch?: boolean; /** Keep the store in memory, so reading a value does not read and parse the config file each time. This makes reads much faster, in particular when the config file is large.
The cache is dropped on every write and whenever the `watch` option reports a change to the config file. Writes read the config file first, so changes made by another process are not lost, but reads only see them when `watch` is enabled or after a write.
The objects returned by `.store`, `.get()` and iteration, and the values passed to the `onDidChange` and `onDidAnyChange` callbacks, are the cache itself, so the plain objects and arrays in them are frozen. Changing one throws a `TypeError`. Use `.set()` and `.delete()` to write, and copy a value first if you want to change it, for example with `structuredClone()`.
@default false */ readonly cache?: boolean; /** The [mode](https://en.wikipedia.org/wiki/File-system_permissions#Numeric_notation) used when creating the config file.
The mode is modified by the [process umask](https://en.wikipedia.org/wiki/Umask), whether it is the default or given by this option. With the typical umask of `0o022`, the default results in `0o644`. Config files are also stored in a location that is typically protected already, so the default is usually fine.
When this option is given, the mode is also applied to an existing config file on every write. Otherwise, an existing config file keeps its mode. A mode given by this option that, after the umask, leaves the file unreadable by its owner throws.
You would usually not need this, but it could be useful if you use a custom `cwd`. Setting `0o600` would make the file only readable by the owner.
Note that setting restrictive permissions can cause problems if different users need to read the file. A common problem is a user running your tool with and without `sudo` and then not being able to access the config the second time.
@default 0o666, reduced by the process umask */ readonly configFileMode?: number;};type Schema
type Schema<T> = { [Property in keyof T]?: ValueSchema;};Package Files (2)
Dependencies (9)
Dev Dependencies (11)
Peer Dependencies (0)
No peer dependencies.
Badge
To add a badge like this one
to your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/conf.
- Markdown[](https://www.jsdocs.io/package/conf)
- HTML<a href="https://www.jsdocs.io/package/conf"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 5456 ms. - Missing or incorrect documentation? Open an issue for this package.