Options
All
  • Public
  • Public/Protected
  • All
Menu

This IndexedDB API interface provides a connection to a database; you can use an IDBDatabase object to open a transaction on your database then create, manipulate, and delete objects (data) in that database. The interface provides the only way to get and manage versions of the database.

Hierarchy

  • EventTarget
    • IDBDatabase

Index

Properties

EventTarget

EventTarget: object

Type declaration

  • constructor: function
    • new __type(): EventTarget
    • Returns EventTarget

  • prototype: EventTarget

name

name: string

Returns the name of the database.

objectStoreNames

objectStoreNames: DOMStringList

Returns a list of the names of object stores in the database.

onabort

onabort: function | null

onclose

onclose: function | null

onerror

onerror: function | null

onversionchange

onversionchange: function | null

version

version: number

Returns the version of the database.

Methods

addEventListener

close

  • close(): void
  • Closes the connection once all running transactions have finished.

    Returns void

createObjectStore

  • Creates a new object store with the given name and options and returns a new IDBObjectStore.

    Throws a "InvalidStateError" DOMException if not called within an upgrade transaction.

    Parameters

    Returns IDBObjectStore

deleteObjectStore

  • deleteObjectStore(name: string): void
  • Deletes the object store with the given name.

    Throws a "InvalidStateError" DOMException if not called within an upgrade transaction.

    Parameters

    • name: string

    Returns void

dispatchEvent

  • dispatchEvent(event: Event): boolean
  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    Parameters

    • event: Event

    Returns boolean

removeEventListener

transaction

  • Returns a new transaction with the given mode ("readonly" or "readwrite") and scope which can be a single object store name or an array of names.

    Parameters

    Returns IDBTransaction

Generated using TypeDoc