Interface AsyncKeyValueRWTransaction

Represents an asynchronous read-write transaction.

Hierarchy

AsyncKeyValueROTransaction
- AsyncKeyValueRWTransaction

Index

Methods

abort commit del get put

Methods

abort

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

Returns Promise<void>
- Defined in src/backends/AsyncStore.ts:160

commit

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

Returns Promise<void>
- Defined in src/backends/AsyncStore.ts:156

del

del(key): Promise<void>
Deletes the data at the given key.
Parameters
- key: string
  
  The key to delete from the store.
Returns Promise<void>
- Defined in src/backends/AsyncStore.ts:152

get

get(key): Promise<Uint8Array>
Retrieves the data at the given key.
Parameters
- key: string
  
  The key to look under for data.
Returns Promise<Uint8Array>
Inherited from AsyncKeyValueROTransaction.get
- Defined in src/backends/AsyncStore.ts:132

put

put(key, data, overwrite): Promise<boolean>
Adds the data to the store under the given key. Overwrites any existing data.
Parameters
- key: string
  
  The key to add the data under.
- data: Uint8Array
  
  The data to add to the store.
- overwrite: boolean
  
  If 'true', overwrite any existing data. If 'false', avoids writing the data if the key exists.
Returns Promise<boolean>
- Defined in src/backends/AsyncStore.ts:147

Generated using TypeDoc