Class IndexedDBStorage

Internalapi

The storage used in the SDK

Hierarchy

Constructors

constructor

Methods

clearStore delete fillStore get getAll getAllKeys getPrefixedKey set subscribeToStorageChanged isSupported

Constructors

constructor

  • Parameters

    • Optional dbName: string

      Name of the database.

    • Optional storeNames: string[]

      An array of object store names to create in the database. The first store in the array will be used as the default if none is specified.

    Returns IndexedDBStorage

Properties

Private db

db: any

Private Readonly dbName

dbName: any

Private initDB

initDB: any

Private isIndexedDBSupported

isIndexedDBSupported: any

Private isSupported

isSupported: any

Private Readonly storeNames

storeNames: any

Private transaction

transaction: any

Performs a transaction on the given object store.

Param

Transaction mode.

Param

The name of the object store.

Param

The operation to perform with the object store.

Methods

clearStore

  • Clears all entries from the specified object store.

    Parameters

    • Optional storeName: string

    Returns Promise<void>

delete

  • Deletes an entry by key from the specified object store.

    Type Parameters

    Parameters

    • key: K
    • Optional storeName: string

    Returns Promise<void>

  • Parameters

    • key: string
    • Optional storeName: string

    Returns Promise<void>

fillStore

  • Copies all key/value pairs from the source store into a target store.

    Parameters

    • targetDBName: string

      Name of the target database.

    • targetStoreName: string

      Name of the target object store.

    • Optional skipKeys: string[]

      Keys to skip.

    • Optional sourceStoreName: string

      (Optional) Source store name – defaults to the default store.

    Returns Promise<void>

get

  • Retrieves a value by key from the specified object store. If no store is specified, the default (first in the list) is used.

    Type Parameters

    Parameters

    • key: K
    • Optional storeName: string

    Returns Promise<StorageKeyReturnType[K]>

  • Parameters

    • key: string
    • Optional storeName: string

    Returns Promise<undefined | string>

getAll

  • Retrieves all values from the specified object store.

    Parameters

    • Optional storeName: string

    Returns Promise<string[]>

getAllKeys

  • Retrieves all keys from the specified object store.

    Parameters

    • Optional storeName: string

    Returns Promise<IDBValidKey[]>

getPrefixedKey

  • Get the key with the internal prefix

    Type Parameters

    Parameters

    • key: K

      the storage key

    Returns string

set

  • Stores a key/value pair in the specified object store.

    Type Parameters

    Parameters

    Returns Promise<void>

  • Parameters

    • key: string
    • value: string
    • Optional storeName: string

    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