Class LocalStorage

Internalapi

A storage that can be used in the browser

Hierarchy

Storage
- LocalStorage

Index

Constructors

Properties

Methods

delete get getPrefixedKey set subscribeToStorageChanged isSupported

Constructors

constructor

new LocalStorage(prefix?): LocalStorage
Parameters
- Optional prefix: string
Returns LocalStorage
Overrides Storage.constructor
- Defined in beacon-core/src/storage/LocalStorage.ts:9

Properties

`Private` `Optional` `Readonly` prefix

prefix?: string

Methods

delete

delete<K>(key): 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/src/storage/LocalStorage.ts:41

get

get<K>(key): 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/src/storage/LocalStorage.ts:16

getPrefixedKey

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

set

set<K>(key, value): 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/src/storage/LocalStorage.ts:33

subscribeToStorageChanged

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

`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/src/storage/LocalStorage.ts:12

Generated using TypeDoc