PluginStorageScopeSpanApi
Defined in: plugin.ts:761
Properties
Section titled “Properties”scopeCount
Section titled “scopeCount”
readonlyscopeCount:number
Defined in: plugin.ts:762
Methods
Section titled “Methods”collection()
Section titled “collection()”collection<
T>(name,definition):object
Defined in: plugin.ts:763
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”string
definition
Section titled “definition”indexes?
Section titled “indexes?”string[]
maxBytes?
Section titled “maxBytes?”number
maxRecords?
Section titled “maxRecords?”number
queryProjection?
Section titled “queryProjection?”"sqlite"
schemaVersion
Section titled “schemaVersion”number
"none" | "shared" | "private"
validate
Section titled “validate”Returns
Section titled “Returns”object
get(
id):PluginCrossScopeRecord<T> |null
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”PluginCrossScopeRecord<T> | null
list()
Section titled “list()”list(
query?):PluginCrossScopeRecord<T>[]
Parameters
Section titled “Parameters”query?
Section titled “query?”equals?
Section titled “equals?”string | number | boolean | null
index?
Section titled “index?”string
limit?
Section titled “limit?”number
Returns
Section titled “Returns”documents()
Section titled “documents()”documents<
M>(name,definition):object
Defined in: plugin.ts:782
Type Parameters
Section titled “Type Parameters”M
Parameters
Section titled “Parameters”string
definition
Section titled “definition”indexes?
Section titled “indexes?”string[]
layout?
Section titled “layout?”"file" | "directory"
maxBytes?
Section titled “maxBytes?”number
maxDocumentBytes?
Section titled “maxDocumentBytes?”number
maxDocuments?
Section titled “maxDocuments?”number
mount?
Section titled “mount?”string
primaryFile?
Section titled “primaryFile?”string
queryProjection?
Section titled “queryProjection?”"sqlite"
schemaVersion
Section titled “schemaVersion”number
"none" | "shared" | "private"
validateMeta
Section titled “validateMeta”Returns
Section titled “Returns”object
get(
id):PluginDocumentRecord<M> &object|null
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”PluginDocumentRecord<M> & object | null
list()
Section titled “list()”list(
query?):PluginDocumentHead<M> &object[]
Parameters
Section titled “Parameters”query?
Section titled “query?”equals?
Section titled “equals?”string | number | boolean | null
index?
Section titled “index?”string
limit?
Section titled “limit?”number
Returns
Section titled “Returns”PluginDocumentHead<M> & object[]