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 keys keysSync markModified remove removeSync set setSync stashOldValue

Constructors

constructor

new SimpleTransaction(store): SimpleTransaction
Parameters
- store: SimpleSyncStore
Returns SimpleTransaction
Inherited from SyncTransaction.constructor
- Defined in src/backends/store/store.ts:38

Properties

`Protected`done

done: boolean = false

Whether the transaction was committed 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:100

[dispose]

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

abort

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

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

abortSync

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

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

commit

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

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

commitSync

commitSync(): void
Commits the transaction.

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

get

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

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

keys

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

Returns Promise<Iterable<bigint>>
Inherited from SyncTransaction.keys
- Defined in src/backends/store/store.ts:137

keysSync

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

Returns Iterable<bigint>
Overrides SyncTransaction.keysSync
- Defined in src/backends/store/simple.ts:89

`Protected`markModified

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

remove

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

removeSync

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

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

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

`Protected`stashOldValue

stashOldValue(id, 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
- id: bigint
- Optionalvalue: Uint8Array
Returns void
- Defined in src/backends/store/simple.ts:137