Class AsyncTransaction<T>`Abstract`

Transaction that only supports asynchronous operations

Type Parameters

T extends Store = Store

Hierarchy (View Summary)

Transaction<T>
- AsyncTransaction

Index

Constructors

Properties

Methods

[asyncDispose] [dispose] abort abortSync commit commitSync get getSync keys keysSync remove removeSync set setSync

Constructors

constructor

new AsyncTransaction<T extends Store = Store>(store: T): AsyncTransaction<T>
Type Parameters
- T extends Store = Store
Parameters
- store: T
Returns AsyncTransaction<T>
Inherited from Transaction.constructor
- Defined in src/backends/store/store.ts:38

Properties

`Protected`done

done: boolean = false

Whether the transaction was committed or aborted

`Protected`store

store: T

Methods

[asyncDispose]

"[asyncDispose]"(): Promise<void>
Returns Promise<void>
Inherited from Transaction.[asyncDispose]
- Defined in src/backends/store/store.ts:100

[dispose]

"[dispose]"(): void
Returns void
Inherited from Transaction.[dispose]
- Defined in src/backends/store/store.ts:111

`Abstract`abort

abort(): Promise<void>
Aborts and rolls back the transaction.

Returns Promise<void>
Inherited from Transaction.abort
- Defined in src/backends/store/store.ts:120

abortSync

abortSync(): never
Aborts and rolls back the transaction.

Returns never
Overrides Transaction.abortSync
- Defined in src/backends/store/store.ts:182

`Abstract`commit

commit(): Promise<void>
Commits the transaction.

Returns Promise<void>
Inherited from Transaction.commit
- Defined in src/backends/store/store.ts:98

commitSync

commitSync(): never
Commits the transaction.

Returns never
Overrides Transaction.commitSync
- Defined in src/backends/store/store.ts:178

`Abstract`get

get(id: number): Promise<Uint8Array<ArrayBufferLike>>
Retrieves data.
Parameters
- id: number
  The key to look under for data.
Returns Promise<Uint8Array<ArrayBufferLike>>
Inherited from Transaction.get
- Defined in src/backends/store/store.ts:59

getSync

getSync(): never
Retrieves data. Throws an error if an error occurs or if the key does not exist.

Returns never
The data stored under the key, or undefined if not present.
Overrides Transaction.getSync
- Defined in src/backends/store/store.ts:166

`Abstract`keys

keys(): Promise<Iterable<number, any, any>>
Gets all of the keys

Returns Promise<Iterable<number, any, any>>
Inherited from Transaction.keys
- Defined in src/backends/store/store.ts:48

keysSync

keysSync(): never
Gets all of the keys

Returns never
Overrides Transaction.keysSync
- Defined in src/backends/store/store.ts:162

`Abstract`remove

remove(id: number): Promise<void>
Deletes the data at ino.
Parameters
- id: number
  The key to delete from the store.
Returns Promise<void>
Inherited from Transaction.remove
- Defined in src/backends/store/store.ts:87

removeSync

removeSync(): never
Deletes the data at ino.

Returns never
Overrides Transaction.removeSync
- Defined in src/backends/store/store.ts:174

`Abstract`set

set(
    id: number,
    data: Uint8Array<ArrayBufferLike>,
    isMetadata?: boolean,
): Promise<void>
Adds the data to the store under an id. Overwrites any existing data.
Parameters
- id: number
  The key to add the data under.
- data: Uint8Array<ArrayBufferLike>
  The data to add to the store.
- OptionalisMetadata: boolean
Returns Promise<void>
Inherited from Transaction.set
- Defined in src/backends/store/store.ts:74

setSync

setSync(): never
Adds the data to the store under and id.

Returns never
Overrides Transaction.setSync
- Defined in src/backends/store/store.ts:170