Class LocalStorage

Internalapi

A storage that can be used in the browser

Hierarchy (View Summary)

Storage
- LocalStorage

Index

Constructors

Methods

delete get getPrefixedKey set subscribeToStorageChanged isSupported

Constructors

constructor

new LocalStorage(prefix?: string): LocalStorage
Parameters
- Optionalprefix: string
Returns LocalStorage
Overrides Storage.constructor
- Defined in beacon-core/dist/esm/storage/LocalStorage.d.ts:9

Methods

delete

delete<K extends StorageKey>(key: K): Promise<void>
Delete a key from storage
Type Parameters
- K extends StorageKey
Parameters
- key: K
  The storage key
Returns Promise<void>
Overrides Storage.delete
- Defined in beacon-core/dist/esm/storage/LocalStorage.d.ts:13

get

get<K extends StorageKey>(key: K): Promise<StorageKeyReturnType[K]>
Gets a value from storage and returns it
Type Parameters
- K extends StorageKey
Parameters
- key: K
  The storage key
Returns Promise<StorageKeyReturnType[K]>
Overrides Storage.get
- Defined in beacon-core/dist/esm/storage/LocalStorage.d.ts:11

getPrefixedKey

getPrefixedKey(key: string): string
Get the key with the internal prefix
Parameters
- key: string
  the storage key
Returns string
Overrides Storage.getPrefixedKey
- Defined in beacon-core/dist/esm/storage/LocalStorage.d.ts:20

set

set<K extends StorageKey>(key: K, value: StorageKeyReturnType[K]): Promise<void>
Sets a value in the storage and persist it
Type Parameters
- K extends StorageKey
Parameters
- key: K
  The storage key
- value: StorageKeyReturnType[K]
  The value to be persisted
Returns Promise<void>
Overrides Storage.set
- Defined in beacon-core/dist/esm/storage/LocalStorage.d.ts:12

subscribeToStorageChanged

subscribeToStorageChanged(
    callback: (
        arg: {
            eventType: "storageCleared" | "entryModified";
            key: null | string;
            newValue: null | string;
            oldValue: null | string;
        },
    ) => {},
): Promise<void>
This event will fire if the storage was modified by someone else, eg. on another tab
Parameters
- callback: (
      arg: {
          eventType: "storageCleared" | "entryModified";
          key: null | string;
          newValue: null | string;
          oldValue: null | string;
      },
  ) => {}
  The callback to be called when a storage value changes
Returns Promise<void>
Overrides Storage.subscribeToStorageChanged
- Defined in beacon-core/dist/esm/storage/LocalStorage.d.ts:14

`Static`isSupported

isSupported(): Promise<boolean>
Returns a promise that resolves to true if the storage option is available on this platform.

Returns Promise<boolean>
Overrides Storage.isSupported
- Defined in beacon-core/dist/esm/storage/LocalStorage.d.ts:10