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 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:39

Properties

`Protected` done

done: boolean = false

Whether the transaction was commited or aborted

`Protected` store

store: T

Methods

[asyncDispose]

[asyncDispose](): Promise<void>
Returns Promise<void>
- Defined in src/backends/store/store.ts:97

[dispose]

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

`Abstract` abort

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

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

`Abstract` abortSync

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

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

`Abstract` commit

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

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

`Abstract` commitSync

commitSync(): void
Commits the transaction.

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

`Abstract` get

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

`Abstract` getSync

getSync(ino): Uint8Array
Retrieves the data at the given key. Throws an error if an error occurs or if the key does not exist.
Parameters
- ino: 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:58

`Abstract` remove

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

`Abstract` removeSync

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

`Abstract` set

set(ino, data): Promise<void>
Adds the data to the store under the given key. Overwrites any existing data.
Parameters
- ino: 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:68

`Abstract` setSync

setSync(ino, data): void
Adds the data to the store under the given key.
Parameters
- ino: bigint
  The key to add the data under.
- data: Uint8Array
  The data to add to the store.
Returns void
True if storage succeeded, false otherwise.
- Defined in src/backends/store/store.ts:78