Class PrefsClass<PrefsType>

Type Parameters

PrefsType = object

Index

Constructors

Properties

Methods

clear create get set

Constructors

constructor

new PrefsClass<PrefsType>(storageKey?): PrefsClass<PrefsType>
Type Parameters
- PrefsType = object
Parameters
- storageKey: string = 'ar-prefs'
Returns PrefsClass<PrefsType>
- Defined in dev/Reactium/reactium-sdk-core/src/browser/Prefs.ts:4

Properties

`Private` storageKey

storageKey: string = 'ar-prefs'

Methods

clear

clear(key?): undefined | PrefsType | {}
Clears the localStorage for the given key or all keys if no key is provided.
Parameters
- Optional key: Path
  The key to clear from localStorage.
Returns undefined | PrefsType | {}
The cleared preferences.
- Defined in dev/Reactium/reactium-sdk-core/src/browser/Prefs.ts:15

create

create<PrefsType>(storageKey): PrefsClass<PrefsType>
Type Parameters
- PrefsType = object
Parameters
- storageKey: string
Returns PrefsClass<PrefsType>
- Defined in dev/Reactium/reactium-sdk-core/src/browser/Prefs.ts:6

get

get<T>(key?, defaultValue?): undefined | PrefsType | T
Gets the value from localStorage for the given key, or the default value if the key is not found.
Type Parameters
- T = any
Parameters
- Optional key: Path
  The key to get from localStorage.
- Optional defaultValue: T
  The default value to return if the key is not found.
Returns undefined | PrefsType | T
The value from localStorage or the default value.
- Defined in dev/Reactium/reactium-sdk-core/src/browser/Prefs.ts:42

set

set<T>(key, value): undefined | PrefsType
Sets the value in localStorage for the given key.
Type Parameters
- T = any
Parameters
- key: Path
  The key to set in localStorage.
- value: T
  The value to set for the key.
Returns undefined | PrefsType
The updated preferences.
- Defined in dev/Reactium/reactium-sdk-core/src/browser/Prefs.ts:57