Class SimpleTransaction

Transaction for simple stores.

See

SimpleSyncStore
SimpleAsyncStore

Hierarchy (view full)

SyncTransaction<SimpleSyncStore>
- SimpleTransaction

Index

Constructors

Properties

done modifiedKeys originalData store

Methods

[asyncDispose] [dispose] abort abortSync commit commitSync get getSync markModified remove removeSync set setSync stashOldValue

Constructors

constructor

new SimpleTransaction(store): SimpleTransaction
Parameters
- store: SimpleSyncStore
Returns SimpleTransaction
Overrides SyncTransaction.constructor
- Defined in src/backends/store/simple.ts:85

Properties

`Protected` done

done: boolean = false

Whether the transaction was commited or aborted

`Protected` modifiedKeys

modifiedKeys: Set<bigint> = ...

List of keys modified in this transaction, if any.

`Protected` originalData

originalData: Map<bigint, void | Uint8Array> = ...

Stores data in the keys we modify prior to modifying them. Allows us to roll back commits.

`Protected` store

store: SimpleSyncStore

Methods

[asyncDispose]

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

[dispose]

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

abort

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

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

abortSync

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

Returns void
Overrides SyncTransaction.abortSync
- Defined in src/backends/store/simple.ts:109

commit

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

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

commitSync

commitSync(): void
Commits the transaction.

Returns void
Overrides SyncTransaction.commitSync
- Defined in src/backends/store/simple.ts:105

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>
Inherited from SyncTransaction.get
- Defined in src/backends/store/store.ts:134

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.
Overrides SyncTransaction.getSync
- Defined in src/backends/store/simple.ts:89

`Protected` markModified

markModified(ino): void
Marks the given key as modified, and stashes its value if it has not been stashed already.
Parameters
- ino: bigint
Returns void
- Defined in src/backends/store/simple.ts:144

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>
Inherited from SyncTransaction.remove
- Defined in src/backends/store/store.ts:140

removeSync

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

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>
Inherited from SyncTransaction.set
- Defined in src/backends/store/store.ts:137

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.
Overrides SyncTransaction.setSync
- Defined in src/backends/store/simple.ts:95

`Protected` stashOldValue

stashOldValue(ino, value?): void
Stashes given key value pair into originalData if it doesn't already exist. Allows us to stash values the program is requesting anyway to prevent needless get requests if the program modifies the data later on during the transaction.
Parameters
- ino: bigint
- Optional value: Uint8Array
Returns void
- Defined in src/backends/store/simple.ts:133