MdKitDocumentAdapter
Interface: MdKitDocumentAdapter
Defined in: packages/mdkit/src/document/documentTypes.ts:48
Storage contract the document hooks talk to. Implement it over tRPC, REST, or
anything else; only readDocument/writeDocument are required, the
checkpoint methods are optional and enable version-history UI.
Methods
readDocument()
readDocument(documentId: string): Promise<MdKitDocumentSnapshot>;Defined in: packages/mdkit/src/document/documentTypes.ts:49
Parameters
| Parameter | Type |
|---|---|
documentId | string |
Returns
Promise<MdKitDocumentSnapshot>
writeDocument()
writeDocument(input: MdKitDocumentWriteInput): Promise<MdKitDocumentWriteResult>;Defined in: packages/mdkit/src/document/documentTypes.ts:50
Parameters
| Parameter | Type |
|---|---|
input | MdKitDocumentWriteInput |
Returns
Promise<MdKitDocumentWriteResult>
resyncDocument()?
optional resyncDocument(documentId: string): Promise<MdKitDocumentSnapshot>;Defined in: packages/mdkit/src/document/documentTypes.ts:53
Parameters
| Parameter | Type |
|---|---|
documentId | string |
Returns
Promise<MdKitDocumentSnapshot>
listDocumentVersions()?
optional listDocumentVersions(documentId: string): Promise<MdKitDocumentVersionSummary[]>;Defined in: packages/mdkit/src/document/documentTypes.ts:54
Parameters
| Parameter | Type |
|---|---|
documentId | string |
Returns
Promise<MdKitDocumentVersionSummary[]>
readDocumentVersion()?
optional readDocumentVersion(input: {
documentId: string;
versionId: string;
}): Promise<
| MdKitDocumentVersionDetail
| null>;Defined in: packages/mdkit/src/document/documentTypes.ts:57
Parameters
| Parameter | Type |
|---|---|
input | { documentId: string; versionId: string; } |
input.documentId | string |
input.versionId | string |
Returns
Promise<
| MdKitDocumentVersionDetail
| null>