Skip to content

@vttforge/core / EmbeddedDocumentOwner

Interface: EmbeddedDocumentOwner ​

The embedded-document writes a sheet makes on its own document.

Extended by ​

Methods ​

createEmbeddedDocuments() ​

createEmbeddedDocuments(name, data, operation?): Promise<unknown[]>

Parameters ​

name ​

string

data ​

readonly Record<string, unknown>[]

operation? ​

Record<string, unknown>

Returns ​

Promise<unknown[]>


deleteEmbeddedDocuments() ​

deleteEmbeddedDocuments(name, ids, operation?): Promise<unknown[]>

Parameters ​

name ​

string

ids ​

readonly string[]

operation? ​

Record<string, unknown>

Returns ​

Promise<unknown[]>


getEmbeddedDocument() ​

getEmbeddedDocument(name, id): unknown

Parameters ​

name ​

string

id ​

string

Returns ​

unknown


updateEmbeddedDocuments() ​

updateEmbeddedDocuments(name, updates, operation?): Promise<unknown[]>

Parameters ​

name ​

string

updates ​

readonly Record<string, unknown>[]

operation? ​

Record<string, unknown>

Returns ​

Promise<unknown[]>

MIT licensed.