Skip to main content

Class: SettingsStateManager

Defined in: utils/state/domain/settingsStateCore.ts:64

Settings State Manager Class

Constructors​

Constructor​

new SettingsStateManager(): SettingsStateManager;

Returns​

SettingsStateManager

Properties​

initializePromise​

initializePromise:
  | Promise<void>
  | null = null;

Defined in: utils/state/domain/settingsStateCore.ts:65

initialized​

initialized: boolean = false;

Defined in: utils/state/domain/settingsStateCore.ts:66

migrationVersion​

private readonly migrationVersion: "1.0.0" = "1.0.0";

Defined in: utils/state/domain/settingsStateCore.ts:67

storageSyncController​

private storageSyncController:
  | AbortController
  | undefined;

Defined in: utils/state/domain/settingsStateCore.ts:68

subscribers​

private readonly subscribers: Map<string, Set<unknown>>;

Defined in: utils/state/domain/settingsStateCore.ts:69

Methods​

cleanup()​

cleanup(): void;

Defined in: utils/state/domain/settingsStateCore.ts:74

Cleanup resources (currently minimal)

Returns​

void

exportSettings()​

exportSettings(): ExportedSettings | null;

Defined in: utils/state/domain/settingsStateCore.ts:85

Export all settings and metadata

Returns​

ExportedSettings | null

getChartSettings()​

getChartSettings(): Record<string, unknown>;

Defined in: utils/state/domain/settingsStateCore.ts:107

Return all chart (chartjs_) settings as object

Returns​

Record<string, unknown>

getSetting()​

getSetting(category: SettingCategory, key?: string | null): unknown;

Defined in: utils/state/domain/settingsStateCore.ts:136

Get a setting (entire category or specific key for object categories)

Parameters​

category​

SettingCategory

key?​

string | null

Returns​

unknown

importSettings()​

importSettings(settingsData: unknown): boolean;

Defined in: utils/state/domain/settingsStateCore.ts:234

Import settings from an exported payload.

The export format is produced by exportSettings.

Parameters​

settingsData​

unknown

Returns​

boolean

initialize()​

initialize(): Promise<void>;

Defined in: utils/state/domain/settingsStateCore.ts:273

Initialize the settings state manager

Returns​

Promise<void>

migrateFromLegacy()​

migrateFromLegacy(): Promise<void>;

Defined in: utils/state/domain/settingsStateCore.ts:331

Initial legacy migration (idempotent)

Returns​

Promise<void>

migrateSettings()​

migrateSettings(): Promise<void>;

Defined in: utils/state/domain/settingsStateCore.ts:353

Perform migrations if required

Returns​

Promise<void>

resetSettings()​

resetSettings(category?:
  | SettingCategory
  | null, options?: ResetSettingsOptions): boolean;

Defined in: utils/state/domain/settingsStateCore.ts:399

Reset settings (single category or all)

Parameters​

category?​

| SettingCategory | null

options?​

ResetSettingsOptions = {}

Returns​

boolean

setSetting()​

setSetting(
   category: SettingCategory,
   value: unknown,
   key?: string | null
): boolean;

Defined in: utils/state/domain/settingsStateCore.ts:476

Set a setting value (entire category or specific key for object categories)

Parameters​

category​

SettingCategory

value​

unknown

key?​

string | null

Returns​

boolean

setupLocalStorageSync()​

setupLocalStorageSync(): void;

Defined in: utils/state/domain/settingsStateCore.ts:561

Wire listeners for cross-tab storage changes

Returns​

void

syncFromLocalStorage()​

syncFromLocalStorage(): void;

Defined in: utils/state/domain/settingsStateCore.ts:599

Sync state from localStorage after external changes

Returns​

void