Class IndexedDBStorage

Internalapi

The storage used in the SDK

Hierarchy

Constructors

constructor

Properties

db dbName initDB isIndexedDBSupported isSupported storeName transaction

Methods

clearStore delete fillStore get getAll getAllKeys getPrefixedKey set subscribeToStorageChanged isSupported

Constructors

constructor

Properties

Private db

db: any

Private Readonly dbName

dbName: any

Private initDB

initDB: any

Private isIndexedDBSupported

isIndexedDBSupported: any

Private isSupported

isSupported: any

Private Readonly storeName

storeName: any

Private transaction

transaction: any

Methods

clearStore

  • Returns Promise<void>

delete

  • Delete a key from storage

    Type Parameters

    Parameters

    • key: K

      The storage key

    Returns Promise<void>

fillStore

  • it copies over all key value pairs from a source store into a target one

    Parameters

    • targetDBName: string

      the name of the target DB

    • targetStoreName: string

      the name of the target store

    • Optional skipKeys: string[]

      all the keys to ignore

    Returns Promise<void>

get

getAll

  • Returns Promise<string[]>

getAllKeys

  • Returns Promise<IDBValidKey[]>

getPrefixedKey

  • Get the key with the internal prefix

    Type Parameters

    Parameters

    • key: K

      the storage key

    Returns string

set

  • Sets a value in the storage and persist it

    Type Parameters

    Parameters

    Returns Promise<void>

subscribeToStorageChanged

  • 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>

    Static isSupported

    • Returns a promise that resolves to true if the storage option is available on this platform.

      Returns Promise<boolean>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc