Class IndexedDB

constructor

• new IndexedDB(name, version): IndexedDB

• Public IndexedDB constructor consuming the name and version used to construct this instance of a Store.Driver.

  Parameters

  • name: string

    The name to address this instance by.
  • version: string

    The version of this instance.

  Returns IndexedDB

Readonly name

Readonly version

length

• get length(): Promise<number>

• Returns the number of key/value pairs.

  Returns Promise<number>

clear

• clear(): Promise<void>

• Removes all key/value pairs, if there are any.

  Returns Promise<void>

  A Promise resolving when this instance was cleared.

getItem

• getItem(key): Promise<null | string>

• Returns the current value associated with the given key, or null if the given key does not exist.

  Parameters

  • key: string

    The key to retrieve the current value for.

  Returns Promise<null | string>

  A Promise resolving to the current value or null.

key

• key(index): Promise<null | string>

• Returns the name of the nth key, or null if n is greater than or equal to the number of key/value pairs.

  Parameters

  • index: number

    The index of the key to retrieve.

  Returns Promise<null | string>

  A Promise resolving to the name of the key or null.

removeItem

• removeItem(key): Promise<void>

• Removes the key/value pair with the given key, if a key/value pair with the given key exists.

  Parameters

  • key: string

    The key to delete the key/value pair by.

  Returns Promise<void>

  A Promise resolving when the key/value pair was removed.

setItem

• setItem(key, value): Promise<void>

• Sets the value of the pair identified by key to value, creating a new key/value pair if none existed for key previously.

  Parameters

  • key: string

    The key to set the key/value pair by.
  • value: string

    The value to associate with the key.

  Returns Promise<void>

  A Promise resolving when the key/value pair was set.