PluginStorageCollection
Defined in: plugin.ts:591
Type Parameters
Section titled “Type Parameters”T
Methods
Section titled “Methods”delete()
Section titled “delete()”delete(
id,options?):boolean
Defined in: plugin.ts:600
Parameters
Section titled “Parameters”string
options?
Section titled “options?”expectedVersion?
Section titled “expectedVersion?”number
Returns
Section titled “Returns”boolean
get(
id):PluginStorageRecord<T> |null
Defined in: plugin.ts:592
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”PluginStorageRecord<T> | null
list()
Section titled “list()”list(
query?):object
Defined in: plugin.ts:593
Parameters
Section titled “Parameters”query?
Section titled “query?”cursor?
Section titled “cursor?”string
equals?
Section titled “equals?”string | number | boolean | null
index?
Section titled “index?”string
limit?
Section titled “limit?”number
Returns
Section titled “Returns”object
data:
PluginStorageRecord<T>[]
next_cursor
Section titled “next_cursor”next_cursor:
string|null
put(
id,value,options?):PluginStorageRecord<T>
Defined in: plugin.ts:599
Parameters
Section titled “Parameters”string
T
options?
Section titled “options?”expectedVersion?
Section titled “expectedVersion?”number | null
Returns
Section titled “Returns”transaction()
Section titled “transaction()”transaction<
Result>(mutate):Result
Defined in: plugin.ts:601
Type Parameters
Section titled “Type Parameters”Result
Section titled “Result”Result
Parameters
Section titled “Parameters”mutate
Section titled “mutate”(transaction) => Result
Returns
Section titled “Returns”Result