Transaction
Defined in: src/backends/store/store.ts:84
A transaction for a store.
Extended by
Section titled “Extended by”Type Parameters
Section titled “Type Parameters”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Transaction<
T>(store):Transaction<T>
Defined in: src/backends/store/store.ts:85
Parameters
Section titled “Parameters”T
Returns
Section titled “Returns”Transaction<T>
Properties
Section titled “Properties”
readonlystore:T
Defined in: src/backends/store/store.ts:85
Methods
Section titled “Methods”abort()?
Section titled “abort()?”
optionalabort():Promise<void>
Defined in: src/backends/store/store.ts:139
Discards the changes, which stores with the atomic flag must implement
Returns
Section titled “Returns”Promise<void>
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
commit()?
Section titled “commit()?”
optionalcommit():Promise<void>
Defined in: src/backends/store/store.ts:133
Applies the changes, which stores with the atomic flag must implement
Returns
Section titled “Returns”Promise<void>
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
abstractget(id,offset,end?):Promise<Uint8Array<ArrayBufferLike> |undefined>
Defined in: src/backends/store/store.ts:96
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>
getSync()
Section titled “getSync()”
abstractgetSync(id,offset,end?):Uint8Array<ArrayBufferLike> |undefined
Defined in: src/backends/store/store.ts:104
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.
keys()
Section titled “keys()”
abstractkeys():Promise<Iterable<number,any,any>>
Defined in: src/backends/store/store.ts:90
Gets all of the keys
Returns
Section titled “Returns”Promise<Iterable<number, any, any>>
remove()
Section titled “remove()”
abstractremove(id):Promise<void>
Defined in: src/backends/store/store.ts:124
Deletes the data at ino.
Parameters
Section titled “Parameters”number
The key to delete from the store.
Returns
Section titled “Returns”Promise<void>
removeSync()
Section titled “removeSync()”
abstractremoveSync(id):void
Defined in: src/backends/store/store.ts:130
Deletes the data at ino.
Parameters
Section titled “Parameters”number
The key to delete from the store.
Returns
Section titled “Returns”void
abstractset(id,data,offset?):Promise<void>
Defined in: src/backends/store/store.ts:111
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>
setSync()
Section titled “setSync()”
abstractsetSync(id,data,offset?):void
Defined in: src/backends/store/store.ts:118
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