Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IDBDatabase

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

Index

Properties

name: string

Returns the name of the database.

objectStoreNames: DOMStringList

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

onabort: null | ((this: IDBDatabase, ev: Event) => any)
onclose: null | ((this: IDBDatabase, ev: Event) => any)
onerror: null | ((this: IDBDatabase, ev: Event) => any)
onversionchange: null | ((this: IDBDatabase, ev: IDBVersionChangeEvent) => any)
version: number

Returns the version of the database.

Methods

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

    Returns void

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

    Returns boolean

  • transaction(storeNames: string | string[], mode?: "readonly" | "readwrite" | "versionchange"): IDBTransaction
  • 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

    • storeNames: string | string[]
    • Optional mode: "readonly" | "readwrite" | "versionchange"

    Returns IDBTransaction

Generated using TypeDoc