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.

MDN Reference

Hierarchy

EventTarget
- IDBDatabase

Index

Properties

name objectStoreNames onabort onclose onerror onversionchange version

Methods

addEventListener close createObjectStore deleteObjectStore dispatchEvent removeEventListener transaction

Properties

`Readonly` name

name: string

Returns the name of the database.

MDN Reference

`Readonly` objectStoreNames

objectStoreNames: DOMStringList

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

MDN Reference

onabort

onabort: null | ((this, ev) => any)

Type declaration

- (this, ev): any
- Parameters
  - this: IDBDatabase
  - ev: Event
  Returns any

onclose

onclose: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: IDBDatabase
  - ev: Event
  Returns any

onerror

onerror: null | ((this, ev) => any)

Type declaration

- (this, ev): any
- Parameters
  - this: IDBDatabase
  - ev: Event
  Returns any

onversionchange

onversionchange: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: IDBDatabase
  - ev: IDBVersionChangeEvent
  Returns any

`Readonly` version

version: number

Returns the version of the database.

MDN Reference

Methods

addEventListener

addEventListener<K>(type, listener, options?): void
Type Parameters
- K extends keyof IDBDatabaseEventMap
Parameters
- type: K
- listener: ((this, ev) => any)
  - - (this, ev): any
    - Parameters
      this: IDBDatabase
      ev: IDBDatabaseEventMap[K]
      Returns any
- Optional options: boolean | AddEventListenerOptions
Returns void
Overrides EventTarget.addEventListener
- Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:13648
addEventListener(type, listener, options?): void
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | AddEventListenerOptions
Returns void
Overrides EventTarget.addEventListener
- Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:13649

close

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

MDN Reference

Returns void
- Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:13625

createObjectStore

createObjectStore(name, options?): IDBObjectStore
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.

MDN Reference
Parameters
- name: string
- Optional options: IDBObjectStoreParameters
Returns IDBObjectStore
- Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:13633

deleteObjectStore

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

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

MDN Reference
Parameters
- name: string
Returns void
- Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:13641

dispatchEvent

dispatchEvent(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.

MDN Reference
Parameters
- event: Event
Returns boolean
Inherited from EventTarget.dispatchEvent
- Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:8215

removeEventListener

removeEventListener<K>(type, listener, options?): void
Type Parameters
- K extends keyof IDBDatabaseEventMap
Parameters
- type: K
- listener: ((this, ev) => any)
  - - (this, ev): any
    - Parameters
      this: IDBDatabase
      ev: IDBDatabaseEventMap[K]
      Returns any
- Optional options: boolean | EventListenerOptions
Returns void
Overrides EventTarget.removeEventListener
- Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:13650
removeEventListener(type, listener, options?): void
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | EventListenerOptions
Returns void
Overrides EventTarget.removeEventListener
- Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:13651

transaction

transaction(storeNames, mode?, options?): 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.

MDN Reference
Parameters
- storeNames: string | string[]
- Optional mode: IDBTransactionMode
- Optional options: IDBTransactionOptions
Returns IDBTransaction
- Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:13647

Interface IDBDatabase

Hierarchy

Index

Properties

Methods

Properties

Readonly name

Readonly objectStoreNames

onabort

Type declaration

Parameters

this: IDBDatabase

ev: Event

Returns any

onclose

Type declaration

Parameters

this: IDBDatabase

ev: Event

Returns any

onerror

Type declaration

Parameters

this: IDBDatabase

ev: Event

Returns any

onversionchange

Type declaration

Parameters

this: IDBDatabase

ev: IDBVersionChangeEvent

Returns any

Readonly version

Methods

addEventListener

Type Parameters

K extends keyof IDBDatabaseEventMap

Parameters

type: K

listener: ((this, ev) => any)

Parameters

this: IDBDatabase

ev: IDBDatabaseEventMap[K]

Returns any

Optional options: boolean | AddEventListenerOptions

Returns void

Parameters

type: string

listener: EventListenerOrEventListenerObject

Optional options: boolean | AddEventListenerOptions

Returns void

close

Returns void

createObjectStore

Parameters

name: string

Optional options: IDBObjectStoreParameters

Returns IDBObjectStore

deleteObjectStore

Parameters

name: string

Returns void

dispatchEvent

Parameters

event: Event

Returns boolean

removeEventListener

Type Parameters

K extends keyof IDBDatabaseEventMap

Parameters

type: K

listener: ((this, ev) => any)

Parameters

this: IDBDatabase

ev: IDBDatabaseEventMap[K]

Returns any

Optional options: boolean | EventListenerOptions

Returns void

Parameters

type: string

`Readonly` name

`Readonly` objectStoreNames

`Readonly` version

`Optional` options: boolean | AddEventListenerOptions

`Optional` options: boolean | AddEventListenerOptions

`Optional` options: IDBObjectStoreParameters

`Optional` options: boolean | EventListenerOptions

`Optional` options: boolean | EventListenerOptions

`Optional` mode: IDBTransactionMode

`Optional` options: IDBTransactionOptions