UiSetting<T> Class

A Ui Setting with namespace and setting name.

Methods

Name Description
constructor<T>(settingNamespace: string, settingName: string, getValue: () => T, applyValue?: (v: T) => void, defaultValue?: T): UiSetting<T> Constructor  
deleteSetting(storage: UiSettingsStorage): Promise<UiSettingsResult> Deletes the setting from UiSettings  
getSetting(storage: UiSettingsStorage): Promise<UiSettingsResult> Gets the setting from UiSettingsStorage  
getSettingAndApplyValue(storage: UiSettingsStorage): Promise<UiSettingsResult> Gets the setting from UiSettings and applies the value using the applyValue function  
saveSetting(storage: UiSettingsStorage): Promise<UiSettingsResult> Saves the setting value from the getValue function to UiSettings  

Properties

Name Type Description
applyValue undefined | (v: T) => void    
defaultValue undefined | T    
getValue () => T    
settingName string    
settingNamespace string    

Defined in

Last Updated: 12 June, 2024