PluginDocumentStore
Defined in: plugin.ts:638
Type Parameters
Section titled “Type Parameters”M
Methods
Section titled “Methods”attachments()
Section titled “attachments()”attachments(
id):PluginDocumentAttachments
Defined in: plugin.ts:653
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”delete()
Section titled “delete()”delete(
id,options?):boolean
Defined in: plugin.ts:652
Parameters
Section titled “Parameters”string
options?
Section titled “options?”expectedVersion?
Section titled “expectedVersion?”number
Returns
Section titled “Returns”boolean
export()
Section titled “export()”export():
object
Defined in: plugin.ts:655
Returns
Section titled “Returns”object
documents
Section titled “documents”documents:
PluginDocumentRecord<M>[]
schema_version
Section titled “schema_version”schema_version:
number
get(
id):PluginDocumentRecord<M> |null
Defined in: plugin.ts:639
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”PluginDocumentRecord<M> | null
head()
Section titled “head()”head(
id):PluginDocumentHead<M> |null
Defined in: plugin.ts:640
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”PluginDocumentHead<M> | null
import()
Section titled “import()”import(
bundle):void
Defined in: plugin.ts:656
Parameters
Section titled “Parameters”bundle
Section titled “bundle”documents
Section titled “documents”PluginDocumentRecord<M>[]
schema_version
Section titled “schema_version”number
Returns
Section titled “Returns”void
list()
Section titled “list()”list(
query?):object
Defined in: plugin.ts:641
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:
PluginDocumentHead<M>[]
next_cursor
Section titled “next_cursor”next_cursor:
string|null
log(
id,name):PluginDocumentLog
Defined in: plugin.ts:654
Parameters
Section titled “Parameters”string
string
Returns
Section titled “Returns”put(
id,value,options?):PluginDocumentRecord<M>
Defined in: plugin.ts:647
Parameters
Section titled “Parameters”string
content
Section titled “content”string
M
options?
Section titled “options?”expectedVersion?
Section titled “expectedVersion?”number | null