PluginStorageScopeApi
Defined in: plugin.ts:685
Methods
Section titled “Methods”blobStore()
Section titled “blobStore()”blobStore(
name,definition):PluginStorageBlobStore
Defined in: plugin.ts:731
Parameters
Section titled “Parameters”string
definition
Section titled “definition”maxBlobBytes?
Section titled “maxBlobBytes?”number
maxBytes?
Section titled “maxBytes?”number
"none" | "shared" | "private"
Returns
Section titled “Returns”collection()
Section titled “collection()”collection<
T>(name,definition):PluginStorageCollection<T>
Defined in: plugin.ts:686
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
migrations?
Section titled “migrations?”object[]
Forward-only upgrades for this collection’s own records, owned by the plugin that declares them. Raising schemaVersion without a step covering the stored version fails the read rather than silently dropping data.
queryProjection?
Section titled “queryProjection?”"sqlite"
schemaVersion
Section titled “schemaVersion”number
"none" | "shared" | "private"
validate
Section titled “validate”Returns
Section titled “Returns”documents()
Section titled “documents()”documents<
M>(name,definition):PluginDocumentStore<M>
Defined in: plugin.ts:710
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
migrations?
Section titled “migrations?”object[]
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”usage()
Section titled “usage()”usage():
object
Defined in: plugin.ts:739
Returns
Section titled “Returns”object
bytes:
number
collections
Section titled “collections”collections:
number
documents?
Section titled “documents?”
optionaldocuments?:number