Class ReactiveIDBTransaction

Hierarchy

ReactiveIDBTransaction

Index

Constructors

constructor

Properties

db

Accessors

Methods

Constructors

constructor

new ReactiveIDBTransaction(transaction: IDBTransaction, db: ReactiveIDBDatabase): ReactiveIDBTransaction

- Defined in reactive-idb-transaction.ts:29
Constructs a ReactiveIDBTransaction

Parameters
- transaction: IDBTransaction
  
  The underlying IDBTransaction object
- db: ReactiveIDBDatabase
  
  The associated ReactiveIDBDatabase of this transaction
Returns ReactiveIDBTransaction

Properties

Readonly db

db: ReactiveIDBDatabase

Accessors

error

get error(): null | DOMException

- Defined in reactive-idb-transaction.ts:13
If the transaction was aborted, returns the error (a DOMException) providing the reason.

Returns null | DOMException

mode

get mode(): IDBTransactionMode

- Defined in reactive-idb-transaction.ts:20
Returns the mode the transaction was created with ("readonly" or "readwrite"), or "versionchange" for an upgrade transaction.

Returns IDBTransactionMode

objectStoreNames

get objectStoreNames(): DOMStringList

- Defined in reactive-idb-transaction.ts:27
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.

Returns DOMStringList

Methods

abort

abort(): void

- Defined in reactive-idb-transaction.ts:45
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: (ev: IDBTransactionEventMap[K]) => void, options?: boolean | AddEventListenerOptions): void

- Defined in reactive-idb-transaction.ts:79
Type parameters
- K: "abort" | "error" | "complete"
Parameters
- type: K
- listener: (ev: IDBTransactionEventMap[K]) => void
  - - (ev: IDBTransactionEventMap[K]): void
    - Parameters
      - ev: IDBTransactionEventMap[K]
      Returns void
- Optional options: boolean | AddEventListenerOptions
Returns void

objectStore

objectStore<T>(name: string, transformer?: ReactiveIDBTransformer<T>): ReactiveIDBObjectStore<T>

- Defined in reactive-idb-transaction.ts:52
Returns a ReactiveIDBObjectStore in the transaction's scope.

Type parameters
- T = unknown
Parameters
- name: string
- transformer: ReactiveIDBTransformer<T> = ...
Returns ReactiveIDBObjectStore<T>

objectStore$

objectStore$<T>(name: string, transformer?: ReactiveIDBTransformer<T>): Observable<ReactiveIDBObjectStore<T>>

- Defined in reactive-idb-transaction.ts:69
Returns a ReactiveIDBObjectStore in the transaction's scope.

Type parameters
- T = unknown
Parameters
- name: string
- transformer: ReactiveIDBTransformer<T> = ...
Returns Observable<ReactiveIDBObjectStore<T>>

removeEventListener

removeEventListener<K>(type: K, listener: (ev: IDBTransactionEventMap[K]) => void, options?: boolean | EventListenerOptions): void

- Defined in reactive-idb-transaction.ts:87
Type parameters
- K: "abort" | "error" | "complete"
Parameters
- type: K
- listener: (ev: IDBTransactionEventMap[K]) => void
  - - (ev: IDBTransactionEventMap[K]): void
    - Parameters
      - ev: IDBTransactionEventMap[K]
      Returns void
- Optional options: boolean | EventListenerOptions
Returns void

Generated using TypeDoc