Chartbreaker
    Preparing search index...

    Interface IDBTransaction

    The IDBTransaction interface of the IndexedDB API provides a static, asynchronous transaction on a database using event handler attributes.

    MDN Reference

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

    Hierarchy

    • EventTarget
      • IDBTransaction
    Index

    Properties

    db durability error mode objectStoreNames onabort oncomplete onerror

    Methods

    abort addEventListener commit dispatchEvent objectStore removeEventListener

    Properties

    db: IDBDatabase

    The db read-only property of the IDBTransaction interface returns the database connection with which this transaction is associated.

    MDN Reference

    durability: IDBTransactionDurability

    The durability read-only property of the IDBTransaction interface returns the durability hint the transaction was created with.

    MDN Reference

    error: null | DOMException

    The IDBTransaction.error property of the IDBTransaction interface returns the type of error when there is an unsuccessful transaction.

    MDN Reference

    mode: IDBTransactionMode

    The mode read-only property of the data in the object stores in the scope of the transaction (i.e., is the mode to be read-only, or do you want to write to the object stores?) The default value is readonly.

    MDN Reference

    objectStoreNames: DOMStringList

    The objectStoreNames read-only property of the of IDBObjectStore objects.

    MDN Reference

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

    MDN Reference

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

    MDN Reference

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

    MDN Reference

    Methods

    • The abort() method of the IDBTransaction interface rolls back all the changes to objects in the database associated with this transaction.

      MDN Reference

      Returns void

    • The commit() method of the IDBTransaction interface commits the transaction if it is called on an active transaction.

      MDN Reference

      Returns void

    • The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

      MDN Reference

      Parameters

      • event: Event

      Returns boolean

    • The objectStore() method of the added to the scope of this transaction.

      MDN Reference

      Parameters

      • name: string

      Returns IDBObjectStore

    Settings

    Member Visibility

    On This Page

    Properties
    Methods