Skip to main content

Function: sanitiseUiSettings()

sanitiseUiSettings(input, defaults): UiSettingsData

Defined in: src/lib/classes/UiSettings/index.ts:85

Keep only valid UI settings from an untrusted value (e.g. stored or imported), using defaults for anything missing or invalid. Other properties are left out.

Parameters​

input​

unknown

defaults​

UiSettingsData

Returns​

UiSettingsData

Example​

sanitiseUiSettings({ theme: "dark", locale: 42 }, { theme: "system", rendering: "cpu" });
// { theme: "dark", rendering: "cpu" }