Class LocalStorageManager

Singleton that batches settings values in memory, keyed by a path of nested keys, and persists them all to localStorage (or reads them back) on demand.

Index

Accessors

Methods

getFromLocalStorageMap saveSettingsToLocalStorage setLocalStorageMap

Accessors

`Static`instance

get instance(): LocalStorageManager
Returns LocalStorageManager
- Defined in packages/viewer/src/localStorage/LocalStorageManager.ts:17

Methods

getFromLocalStorageMap

getFromLocalStorageMap<T>(keys: string[]): RecursivePartial<T>
Get settings from localStorage.
Type Parameters
- T
Parameters
- keys: string[]
  Array of keys to access the settings.
Returns RecursivePartial<T>
- Defined in packages/viewer/src/localStorage/LocalStorageManager.ts:55

saveSettingsToLocalStorage

saveSettingsToLocalStorage(): void
Save localStorageMap to localStorage.

Returns void
- Defined in packages/viewer/src/localStorage/LocalStorageManager.ts:92

setLocalStorageMap

setLocalStorageMap<T>(keys: string[], settings: RecursivePartial<T>): void
Add settings to the localStorage map to save it in localStorage when {@link_saveSettingsToLocalStorage} is called.
Type Parameters
- T
Parameters
- keys: string[]
  Array of keys to access the settings.
- settings: RecursivePartial<T>
Returns void
- Defined in packages/viewer/src/localStorage/LocalStorageManager.ts:29