Class Storage`Abstract`

Internalapi

The storage used in the SDK

Hierarchy

Storage

Index

Constructors

Methods

delete get getPrefixedKey set subscribeToStorageChanged isSupported

Constructors

constructor

new Storage(): Storage
Returns Storage

Methods

`Abstract` 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>
- Defined in types/storage/Storage.ts:36

`Abstract` 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]>
- Defined in types/storage/Storage.ts:21

`Abstract` getPrefixedKey

getPrefixedKey<K>(key): string
Get the key with the internal prefix
Type Parameters
- K extends StorageKey
Parameters
- key: K
  
  the storage key
Returns string
- Defined in types/storage/Storage.ts:57

`Abstract` 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>
- Defined in types/storage/Storage.ts:29

`Abstract` 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>
- Defined in types/storage/Storage.ts:43

`Static` isSupported

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

Returns Promise<boolean>
- Defined in types/storage/Storage.ts:12

Generated using TypeDoc