Interface IDBTransaction

EventTarget is a DOM interface implemented by objects that can receive events and may have listeners for them.

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 (view full)

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

  • addEventListener<K>(type, listener, options?): void

  • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

    The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

    When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

    When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

    When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

    If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

    The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

    Type Parameters

    Parameters

    Returns void

  • addEventListener(type, listener, options?): void

  • Parameters

    Returns void

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

    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