SyncMapTransaction
Defined in: src/backends/store/map.ts:22
Transaction for map stores.
SyncMapStore
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new SyncMapTransaction(
store):SyncMapTransaction
Defined in: src/backends/store/store.ts:85
Parameters
Section titled “Parameters”Returns
Section titled “Returns”SyncMapTransaction
Inherited from
Section titled “Inherited from”Properties
Section titled “Properties”
readonlystore:SyncMapStore
Defined in: src/backends/store/map.ts:23
Overrides
Section titled “Overrides”Methods
Section titled “Methods”abort()
Section titled “abort()”abort():
Promise<void>
Defined in: src/backends/store/store.ts:168
Discards the changes, which stores with the atomic flag must implement
Returns
Section titled “Returns”Promise<void>
Inherited from
Section titled “Inherited from”abortSync()?
Section titled “abortSync()?”
optionalabortSync():void
Defined in: src/backends/store/store.ts:142
Discards the changes, which stores with the atomic flag must implement
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”commit()
Section titled “commit()”commit():
Promise<void>
Defined in: src/backends/store/store.ts:164
Applies the changes, which stores with the atomic flag must implement
Returns
Section titled “Returns”Promise<void>
Inherited from
Section titled “Inherited from”commitSync()?
Section titled “commitSync()?”
optionalcommitSync():void
Defined in: src/backends/store/store.ts:136
Applies the changes, which stores with the atomic flag must implement
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”get(
id,offset?,end?):Promise<Uint8Array<ArrayBufferLike> |undefined>
Defined in: src/backends/store/map.ts:30
Retrieves data.
Parameters
Section titled “Parameters”number
The key to look under for data.
offset?
Section titled “offset?”number
number
Returns
Section titled “Returns”Promise<Uint8Array<ArrayBufferLike> | undefined>
Overrides
Section titled “Overrides”getSync()
Section titled “getSync()”getSync(
id,offset?,end?):Uint8Array<ArrayBufferLike> |undefined
Defined in: src/backends/store/map.ts:34
Retrieves data. Throws an error if an error occurs or if the key does not exist.
Parameters
Section titled “Parameters”number
The key to look under for data.
offset?
Section titled “offset?”number
number
Returns
Section titled “Returns”Uint8Array<ArrayBufferLike> | undefined
The data stored under the key, or undefined if not present.
Overrides
Section titled “Overrides”keys()
Section titled “keys()”keys():
Promise<Iterable<number,any,any>>
Defined in: src/backends/store/map.ts:26
Gets all of the keys
Returns
Section titled “Returns”Promise<Iterable<number, any, any>>
Overrides
Section titled “Overrides”remove()
Section titled “remove()”remove(
id):Promise<void>
Defined in: src/backends/store/store.ts:160
Deletes the data at ino.
Parameters
Section titled “Parameters”number
The key to delete from the store.
Returns
Section titled “Returns”Promise<void>
Inherited from
Section titled “Inherited from”removeSync()
Section titled “removeSync()”removeSync(
id):void
Defined in: src/backends/store/map.ts:42
Deletes the data at ino.
Parameters
Section titled “Parameters”number
The key to delete from the store.
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”set(
id,data,offset?):Promise<void>
Defined in: src/backends/store/store.ts:156
Stores data under an id.
Without offset, replaces any existing data.
With offset, writes the data at offset and keeps the rest, which partial stores must support.
Parameters
Section titled “Parameters”number
Uint8Array
offset?
Section titled “offset?”number
Returns
Section titled “Returns”Promise<void>
Inherited from
Section titled “Inherited from”setSync()
Section titled “setSync()”setSync(
id,data,offset?):void
Defined in: src/backends/store/map.ts:38
Stores data under an id.
Without offset, replaces any existing data.
With offset, writes the data at offset and keeps the rest, which partial stores must support.
Parameters
Section titled “Parameters”number
Uint8Array
offset?
Section titled “offset?”number
Returns
Section titled “Returns”void