Class SettingsManager<T, D>

constructor

• new SettingsManager<T, D>(namespace, defaultSettings?): SettingsManager<T, D>

• Creates a SettingsManager. This does not load any settings from storage; call the load() method before attempting to manage any settings.

  Prefer calling init over constructing instances of this class directly, as init() automatically loads settings from the file system.

  Type Parameters

  • T extends Record<string, Jsonifiable>
  • D extends string | number | symbol

  Parameters

  • namespace: string

    Namespace of settings to manage.
  • defaultSettings: Partial<T> = {}

  Returns SettingsManager<T, D>

namespace

all

• all(): T

• Returns a copy of the settings data stored in this manager.

  Returns T

  Current values of all settings in this manager's namespace.

delete

• delete(key): boolean

• Deletes a setting.

  Parameters

  • key: Extract<keyof T, string>

    Key of the setting to delete.

  Returns boolean

  Whether the setting was successfully deleted.

get

• get<K, F>(key, fallback?): K extends D
      ? NonNullable<T[K<K>]>
      : F extends undefined | null
          ? undefined | T[K]
          : F | NonNullable<T[K]>

• Gets a setting.

  Type Parameters

  • K extends string
  • F extends undefined | Jsonifiable

  Parameters

  • key: K

    Key of the setting to retrieve.
  • Optionalfallback: F

    Value to return if the key does not already exist.

  Returns K extends D
      ? NonNullable<T[K<K>]>
      : F extends undefined | null
          ? undefined | T[K]
          : F | NonNullable<T[K]>

has

• has(key): boolean

• Determines whether a setting exists for this namespace.

  Parameters

  • key: Extract<keyof T, string>

    Key to look for.

  Returns boolean

  Whether the setting already exists for this namespace.

load

• load(): Promise<void>

• Loads the latest stored settings for this namespace from the user's file system into this manager. This must be called before managing any settings, unless you have created an instance using init(), which calls this method.

  Returns Promise<void>

set

• set<K>(key, value): void

• Sets a setting.

  Type Parameters

  • K extends string

  Parameters

  • key: K

    Key of the setting to set.
  • value: T[K]

    Value to set for the setting.

  Returns void