Class Transaction<T>`Abstract`

A transaction for a store.

Type Parameters

T extends Store = Store

Hierarchy (view full)

Transaction
- SyncTransaction
- AsyncTransaction

Index

Constructors

Properties

Methods

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

Constructors

constructor

new Transaction<T>(store): Transaction<T>
Type Parameters
- T extends Store = Store
Parameters
- store: T
Returns Transaction<T>
- 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>
- Defined in src/backends/store/store.ts:100

[dispose]

[dispose](): void
Returns void
- Defined in src/backends/store/store.ts:113

`Abstract`abort

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

Returns Promise<void>
- Defined in src/backends/store/store.ts:124

`Abstract`abortSync

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

Returns void
- Defined in src/backends/store/store.ts:129

`Abstract`commit

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

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

`Abstract`commitSync

commitSync(): void
Commits the transaction.

Returns void
- Defined in src/backends/store/store.ts:111

`Abstract`get

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

`Abstract`getSync

getSync(id): Uint8Array
Retrieves data. Throws an error if an error occurs or if the key does not exist.
Parameters
- id: bigint
  The key to look under for data.
Returns Uint8Array
The data stored under the key, or undefined if not present.
- Defined in src/backends/store/store.ts:67

`Abstract`keys

keys(): Promise<Iterable<bigint>>
Gets all of the keys

Returns Promise<Iterable<bigint>>
- Defined in src/backends/store/store.ts:48

`Abstract`keysSync

keysSync(): Iterable<bigint>
Gets all of the keys

Returns Iterable<bigint>
- Defined in src/backends/store/store.ts:53

`Abstract`remove

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

`Abstract`removeSync

removeSync(id): void
Deletes the data at ino.
Parameters
- id: bigint
  The key to delete from the store.
Returns void
- Defined in src/backends/store/store.ts:93

`Abstract`set

set(id, data): Promise<void>
Adds the data to the store under an id. Overwrites any existing data.
Parameters
- id: bigint
  The key to add the data under.
- data: Uint8Array
  The data to add to the store.
Returns Promise<void>
- Defined in src/backends/store/store.ts:74

`Abstract`setSync

setSync(id, data): void
Adds the data to the store under and id.
Parameters
- id: bigint
  The key to add the data under.
- data: Uint8Array
  The data to add to the store.
Returns void
- Defined in src/backends/store/store.ts:81