Class SyncMapTransaction

Transaction for map stores.

See

SyncMapStore

Hierarchy (View Summary)

SyncTransaction<SyncMapStore>
- SyncMapTransaction

Index

Constructors

Properties

Methods

get getSync keys remove removeSync set setSync

Constructors

constructor

new SyncMapTransaction(store: SyncMapStore): SyncMapTransaction
Parameters
- store: SyncMapStore
Returns SyncMapTransaction
Inherited from SyncTransaction.constructor
- Defined in src/backends/store/store.ts:82

Properties

`Readonly`store

store: SyncMapStore

Methods

get

get(id: number): Promise<undefined | Uint8Array<ArrayBufferLike>>
Retrieves data.
Parameters
- id: number
  The key to look under for data.
Returns Promise<undefined | Uint8Array<ArrayBufferLike>>
Overrides SyncTransaction.get
- Defined in src/backends/store/map.ts:29

getSync

getSync(id: number): undefined | Uint8Array<ArrayBufferLike>
Retrieves data. Throws an error if an error occurs or if the key does not exist.
Parameters
- id: number
  The key to look under for data.
Returns undefined | Uint8Array<ArrayBufferLike>
The data stored under the key, or undefined if not present.
Overrides SyncTransaction.getSync
- Defined in src/backends/store/map.ts:33

keys

keys(): Promise<Iterable<number, any, any>>
Gets all of the keys

Returns Promise<Iterable<number, any, any>>
Overrides SyncTransaction.keys
- Defined in src/backends/store/map.ts:25

remove

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

removeSync

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

set

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

setSync

setSync(id: number, data: Uint8Array): void
Adds the data to the store under and id.
Parameters
- id: number
  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/map.ts:37