Class default<T>

constructor

• new default<T>(partialOptions?): default<T>

• Type Parameters

  • T extends Record<string, any> = Record<string, unknown>

  Parameters

  • Optional partialOptions: Readonly<Partial<Options<T>>>

  Returns default<T>

Readonly events

Readonly path

size

• get size(): number

• Returns number

store

• get store(): T

• Returns T

• set store(value): void

• Parameters

  • value: T

  Returns void

[iterator]

• [iterator](): IterableIterator<[keyof T, T[keyof T]]>

• Returns IterableIterator<[keyof T, T[keyof T]]>

clear

• clear(): void

• Delete all items.

  This resets known items to their default values, if defined by the defaults or schema option.

  Returns void

delete

• delete<Key>(key): void

• Delete an item.

  Type Parameters

  • Key extends string | number | symbol

  Parameters

  • key: Key

    The key of the item to delete.

  Returns void

get

• get<Key>(key): T[Key]

• Get an item.

  Type Parameters

  • Key extends string | number | symbol

  Parameters

  • key: Key

    The key of the item to get.

  Returns T[Key]
• get<Key>(key, defaultValue): Required<T>[Key]

• Type Parameters

  • Key extends string | number | symbol

  Parameters

  • key: Key

  • defaultValue: Required<T>[Key]

  Returns Required<T>[Key]

• get<Key, Value>(key, defaultValue?): Value

• Type Parameters

  • Key extends string

  • Value = unknown

  Parameters

  • key: Exclude<Key, keyof T>

  • Optional defaultValue: Value

  Returns Value

has

• has<Key>(key): boolean

• Check if an item exists.

  Type Parameters

  • Key extends string | number | symbol

  Parameters

  • key: string | Key

    The key of the item to check.

  Returns boolean

onDidAnyChange

• onDidAnyChange(callback): Unsubscribe

• Watches the whole config object, calling callback on any changes.

  Parameters

  • callback: OnDidAnyChangeCallback<T>

    A callback function that is called on any changes. When a key is first set oldValue will be undefined, and when a key is deleted newValue will be undefined.

  Returns Unsubscribe

  A function, that when called, will unsubscribe.

onDidChange

• onDidChange<Key>(key, callback): Unsubscribe

• Watches the given key, calling callback on any changes.

  Type Parameters

  • Key extends string | number | symbol

  Parameters

  • key: Key

    The key wo watch.

  • callback: OnDidChangeCallback<T[Key]>

    A callback function that is called on any changes. When a key is first set oldValue will be undefined, and when a key is deleted newValue will be undefined.

  Returns Unsubscribe

  A function, that when called, will unsubscribe.

reset

• reset<Key>(...keys): void

• Reset items to their default values, as defined by the defaults or schema option.

  Type Parameters

  • Key extends string | number | symbol

  Parameters

  • Rest ...keys: Key[]

    The keys of the items to reset.

  Returns void

  See

  clear() to reset all items.

set

• set<Key>(key, value?): void

• Set an item or multiple items at once.

  Type Parameters

  • Key extends string | number | symbol

  Parameters

  • key: Key

  • Optional value: T[Key]

    Must be JSON serializable. Trying to set the type undefined, function, or symbol will result in a TypeError.

  Returns void
• set(key, value): void

• Parameters

  • key: string

  • value: unknown

  Returns void

• set(object): void

• Parameters

  • object: Partial<T>

  Returns void