Interface IDBTransaction

interface IDBTransaction {
    db: IDBDatabase;
    durability: IDBTransactionDurability;
    error: null | DOMException;
    mode: IDBTransactionMode;
    objectStoreNames: DOMStringList;
    onabort: null | ((this, ev) => any);
    oncomplete: null | ((this, ev) => any);
    onerror: null | ((this, ev) => any);
    abort(): void;
    addEventListener<K>(type, listener, options?): void;
    addEventListener(type, listener, options?): void;
    commit(): void;
    dispatchEvent(event): boolean;
    objectStore(name): IDBObjectStore;
    removeEventListener<K>(type, listener, options?): void;
    removeEventListener(type, listener, options?): void;
}

Hierarchy

  • EventTarget
    • IDBTransaction

Properties

db durability error mode objectStoreNames onabort oncomplete onerror

Methods

abort addEventListener commit dispatchEvent objectStore removeEventListener

Properties

Readonly db

db: IDBDatabase

Returns the transaction's connection.

Readonly durability

durability: IDBTransactionDurability

Readonly error

error: null | 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: 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, ev) => any)

Type declaration

oncomplete

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

Type declaration

onerror

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

Type declaration

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

commit

  • commit(): void

  • Returns void

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.

    Parameters

    • event: Event

    Returns boolean

objectStore

  • objectStore(name): IDBObjectStore

  • Returns an IDBObjectStore in the transaction's scope.

    Parameters

    • name: string

    Returns IDBObjectStore

removeEventListener

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc