Class SettingsManager<SettingsSchema>

constructor

• new SettingsManager<SettingsSchema>(defaultSettings, options?): SettingsManager<SettingsSchema>

• Type Parameters

  • SettingsSchema extends {} = any

  Parameters

  • defaultSettings: SettingsSchema

  • options: ConfigOptions = {}

  Returns SettingsManager<SettingsSchema>

default

options

get

• get<K>(key): Promise<PathValue<SettingsSchema, K>>

• Gets the value of a setting directly from the storage. Also updates cache.

  Type Parameters

  • K extends string | number | symbol

  Parameters

  • key: K

    The key for the setting. Key supports dot notation. See https://github.com/harshkhandeparkar/tauri-settings#dot-notation.

  Returns Promise<PathValue<SettingsSchema, K>>

  The value of the setting

getCache

• getCache<K>(key): PathValue<SettingsSchema, K>

• Sets the value of a setting from the cache.

  Type Parameters

  • K extends string | number | symbol

  Parameters

  • key: K

    The key for the setting. Key supports dot notation. See https://github.com/harshkhandeparkar/tauri-settings#dot-notation.

  Returns PathValue<SettingsSchema, K>

  The value of the setting

hasCache

• hasCache<K>(key): boolean

• Checks whether a key exists in the settings cache.

  Type Parameters

  • K extends string | number | symbol

  Parameters

  • key: K

    The key for the setting. Key supports dot notation. See https://github.com/harshkhandeparkar/tauri-settings#dot-notation.

  Returns boolean

initialize

• initialize(): Promise<SettingsSchema>

• Initializes a settings file with the defaults. If settings exist, load them.

  Returns Promise<SettingsSchema>

  The entire settings object

set

• set<K, V>(key, value): Promise<SettingsSchema>

• Sets the value for a setting directly to the storage. Also updates cache.

  Type Parameters

  • K extends string | number | symbol

  • V

  Parameters

  • key: K

    The key for the setting. Key supports dot notation. See https://github.com/harshkhandeparkar/tauri-settings#dot-notation.

  • value: V

    The new value for the setting

  Returns Promise<SettingsSchema>

  The entire settings object

setCache

• setCache<K, V>(key, value): V

• Sets the value for a setting. Only updates cache.

  Type Parameters

  • K extends string | number | symbol

  • V

  Parameters

  • key: K

    The key for the setting. Key supports dot notation. See https://github.com/harshkhandeparkar/tauri-settings#dot-notation.

  • value: V

    The new value for the setting

  Returns V

  The entire settings object

syncCache

• syncCache(): Promise<SettingsSchema>

• Saves the current settings cache to the storage.

  Returns Promise<SettingsSchema>

  The entire settings object