Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IDBTransaction

Hierarchy

  • EventTarget
    • IDBTransaction

Index

Properties

Methods

Properties

Readonly db

db: internal.IDBDatabase

Returns the transaction's connection.

Readonly durability

durability: IDBTransactionDurability

Readonly error

error: null | internal.DOMException

If the transaction was aborted, returns the error (a DOMException) providing the reason.

Readonly mode

mode: IDBTransactionMode

Returns the mode the transaction was created with ("readonly" or "readwrite"), or "versionchange" for an upgrade transaction.

Readonly objectStoreNames

objectStoreNames: internal.DOMStringList

Returns a list of the names of object stores in the transaction's scope. For an upgrade transaction this is all object stores in the database.

onabort

onabort: null | ((this: internal.IDBTransaction, ev: Event) => any)

oncomplete

oncomplete: null | ((this: internal.IDBTransaction, ev: Event) => any)

onerror

onerror: null | ((this: internal.IDBTransaction, ev: Event) => any)

Methods

abort

  • abort(): void

  • Aborts the transaction. All pending requests will fail with a "AbortError" DOMException and all changes made to the database will be reverted.

    Returns void

addEventListener

  • addEventListener<K>(type: K, listener: ((this: internal.IDBTransaction, ev: IDBTransactionEventMap[K]) => any), options?: boolean | AddEventListenerOptions): void
  • addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void

commit

  • commit(): void

  • 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

objectStore

  • Returns an IDBObjectStore in the transaction's scope.

    Parameters

    • name: string

    Returns internal.IDBObjectStore

removeEventListener

  • removeEventListener<K>(type: K, listener: ((this: internal.IDBTransaction, ev: IDBTransactionEventMap[K]) => any), options?: boolean | EventListenerOptions): void
  • removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void

Generated using TypeDoc