Interface IDBTransaction
db: IDBDatabase;
durability: IDBTransactionDurability;
error: DOMException;
mode: IDBTransactionMode;
objectStoreNames: DOMStringList;
onabort: ((this: IDBTransaction, ev: Event) => any);
oncomplete: ((this: IDBTransaction, ev: Event) => any);
onerror: ((this: IDBTransaction, ev: Event) => any);
abort(): void;
addEventListener<K>(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>(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 (view full)
Index
Properties
Readonlydb
Returns the transaction's connection.
Readonlydurability
Readonlyerror
If the transaction was aborted, returns the error (a DOMException) providing the reason.
Readonlymode
Returns the mode the transaction was created with ("readonly" or "readwrite"), or "versionchange" for an upgrade transaction.
ReadonlyobjectStoreNames
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
oncomplete
onerror
Methods
abort
addEventListener
- add
Event <K>(type, listener, options?): voidListener 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
- K extends keyof IDBTransactionEventMap
Parameters
- type: K
- listener: ((this: IDBTransaction, ev: IDBTransactionEventMap[K]) => any)
- (this, ev): any
Parameters
- this: IDBTransaction
- ev: IDBTransactionEventMap[K]
Returns any
Optionaloptions: boolean | AddEventListenerOptions
Returns void
- add
Event (type, listener, options?): voidListener 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.
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
Optionaloptions: boolean | AddEventListenerOptions
Returns void
commit
dispatchEvent
- dispatch
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
- object
Store (name): IDBObjectStore Returns an IDBObjectStore in the transaction's scope.
Parameters
- name: string
Returns IDBObjectStore
removeEventListener
- remove
Event <K>(type, listener, options?): voidListener Removes the event listener in target's event listener list with the same type, callback, and options.
Type Parameters
- K extends keyof IDBTransactionEventMap
Parameters
- type: K
- listener: ((this: IDBTransaction, ev: IDBTransactionEventMap[K]) => any)
- (this, ev): any
Parameters
- this: IDBTransaction
- ev: IDBTransactionEventMap[K]
Returns any
Optionaloptions: boolean | EventListenerOptions
Returns void
- remove
Event (type, listener, options?): voidListener Removes the event listener in target's event listener list with the same type, callback, and options.
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
Optionaloptions: boolean | EventListenerOptions
Returns void
MDN Reference