Skip to main content

Interface: SettingsModel

Defined in: src/components/Settings/useSettingsModel.ts:64

Data model for the Settings page.

Properties​

availableThemes​

readonly availableThemes: readonly ThemeName[];

Defined in: src/components/Settings/useSettingsModel.ts:65

clearError​

readonly clearError: () => void;

Defined in: src/components/Settings/useSettingsModel.ts:66

Returns​

void

fullResyncSites​

readonly fullResyncSites: () => Promise<void>;

Defined in: src/components/Settings/useSettingsModel.ts:67

Returns​

Promise<void>

isDark​

readonly isDark: boolean;

Defined in: src/components/Settings/useSettingsModel.ts:68

isLoading​

readonly isLoading: boolean;

Defined in: src/components/Settings/useSettingsModel.ts:69

lastBackupMetadata​

readonly lastBackupMetadata:
  | SerializedDatabaseBackupMetadata
  | undefined;

Defined in: src/components/Settings/useSettingsModel.ts:70

lastError​

readonly lastError: string | undefined;

Defined in: src/components/Settings/useSettingsModel.ts:71

persistHistoryLimit​

readonly persistHistoryLimit: (limit: number) => Promise<void>;

Defined in: src/components/Settings/useSettingsModel.ts:72

Parameters​

limit​

number

Returns​

Promise<void>

requestConfirmation​

readonly requestConfirmation: (options: ConfirmDialogOptions) => Promise<boolean>;

Defined in: src/components/Settings/useSettingsModel.ts:73

Parameters​

options​

ConfirmDialogOptions

Returns​

Promise<boolean>

resetSettings​

readonly resetSettings: () => Promise<{
  message: string;
  success: boolean;
}>;

Defined in: src/components/Settings/useSettingsModel.ts:74

Returns​

Promise<{ message: string; success: boolean; }>

restoreSqliteBackup​

readonly restoreSqliteBackup: (payload: SerializedDatabaseRestorePayload) => Promise<SerializedDatabaseRestoreResult>;

Defined in: src/components/Settings/useSettingsModel.ts:75

Parameters​

payload​

SerializedDatabaseRestorePayload

Returns​

Promise<SerializedDatabaseRestoreResult>

saveSqliteBackup​

readonly saveSqliteBackup: () => Promise<SerializedDatabaseBackupSaveResult>;

Defined in: src/components/Settings/useSettingsModel.ts:76

Returns​

Promise<SerializedDatabaseBackupSaveResult>

setError​

readonly setError: (error: string | undefined) => void;

Defined in: src/components/Settings/useSettingsModel.ts:77

Parameters​

error​

string | undefined

Returns​

void

setTheme​

readonly setTheme: (themeName: ThemeName) => void;

Defined in: src/components/Settings/useSettingsModel.ts:78

Parameters​

themeName​

ThemeName

Returns​

void

settings​

readonly settings: AppSettings;

Defined in: src/components/Settings/useSettingsModel.ts:79

showButtonLoading​

readonly showButtonLoading: boolean;

Defined in: src/components/Settings/useSettingsModel.ts:80

updateSettings​

readonly updateSettings: (settings: Partial<AppSettings>) => void;

Defined in: src/components/Settings/useSettingsModel.ts:81

Parameters​

settings​

Partial<AppSettings>

Returns​

void