MdKitBackendStore
Type Alias: MdKitBackendStore
type MdKitBackendStore = {
createCheckpoint?: | MdKitDocumentVersionSummary
| Promise<MdKitDocumentVersionSummary>;
getLatestCheckpoint?: | MdKitDocumentVersionDetail
| Promise<
| MdKitDocumentVersionDetail
| null>
| null;
listDocumentVersions?: | MdKitDocumentVersionSummary[]
| Promise<MdKitDocumentVersionSummary[]>;
readCollaborationState?: | Uint8Array<ArrayBufferLike>
| Promise<Uint8Array<ArrayBufferLike> | null>
| null;
readDocument: | MdKitDocumentSnapshot
| Promise<MdKitDocumentSnapshot>;
readDocumentVersion?: | MdKitDocumentVersionDetail
| Promise<
| MdKitDocumentVersionDetail
| null>
| null;
resyncDocument?: | MdKitDocumentSnapshot
| Promise<MdKitDocumentSnapshot>;
restoreDocumentVersion?: | MdKitDocumentWriteResult
| Promise<MdKitDocumentWriteResult>;
writeCollaborationState?: void | Promise<void>;
writeDocument: | MdKitDocumentWriteResult
| Promise<MdKitDocumentWriteResult>;
};Defined in: packages/mdkit/src/transport/backend.ts:32
Application-owned persistence contract consumed by createMdKitBackend.
Implement it with your database; mdkit calls createCheckpoint when the
configured CheckpointPolicy triggers — the store never interprets the
policy itself.
Methods
createCheckpoint()?
optional createCheckpoint(input: MdKitCreateCheckpointInput):
| MdKitDocumentVersionSummary
| Promise<MdKitDocumentVersionSummary>;Defined in: packages/mdkit/src/transport/backend.ts:33
Parameters
| Parameter | Type |
|---|---|
input | MdKitCreateCheckpointInput |
Returns
| MdKitDocumentVersionSummary
| Promise<MdKitDocumentVersionSummary>
getLatestCheckpoint()?
optional getLatestCheckpoint(documentId: string):
| MdKitDocumentVersionDetail
| Promise<
| MdKitDocumentVersionDetail
| null>
| null;Defined in: packages/mdkit/src/transport/backend.ts:36
Parameters
| Parameter | Type |
|---|---|
documentId | string |
Returns
| MdKitDocumentVersionDetail
| Promise<
| MdKitDocumentVersionDetail
| null>
| null
listDocumentVersions()?
optional listDocumentVersions(documentId: string):
| MdKitDocumentVersionSummary[]
| Promise<MdKitDocumentVersionSummary[]>;Defined in: packages/mdkit/src/transport/backend.ts:39
Parameters
| Parameter | Type |
|---|---|
documentId | string |
Returns
| MdKitDocumentVersionSummary[]
| Promise<MdKitDocumentVersionSummary[]>
readCollaborationState()?
optional readCollaborationState(documentName: string):
| Uint8Array<ArrayBufferLike>
| Promise<Uint8Array<ArrayBufferLike> | null>
| null;Defined in: packages/mdkit/src/transport/backend.ts:42
Parameters
| Parameter | Type |
|---|---|
documentName | string |
Returns
| Uint8Array<ArrayBufferLike>
| Promise<Uint8Array<ArrayBufferLike> | null>
| null
readDocument()
readDocument(documentId: string):
| MdKitDocumentSnapshot
| Promise<MdKitDocumentSnapshot>;Defined in: packages/mdkit/src/transport/backend.ts:45
Parameters
| Parameter | Type |
|---|---|
documentId | string |
Returns
| MdKitDocumentSnapshot
| Promise<MdKitDocumentSnapshot>
readDocumentVersion()?
optional readDocumentVersion(input: {
documentId: string;
versionId: string;
}):
| MdKitDocumentVersionDetail
| Promise<
| MdKitDocumentVersionDetail
| null>
| null;Defined in: packages/mdkit/src/transport/backend.ts:48
Parameters
| Parameter | Type |
|---|---|
input | { documentId: string; versionId: string; } |
input.documentId | string |
input.versionId | string |
Returns
| MdKitDocumentVersionDetail
| Promise<
| MdKitDocumentVersionDetail
| null>
| null
resyncDocument()?
optional resyncDocument(documentId: string):
| MdKitDocumentSnapshot
| Promise<MdKitDocumentSnapshot>;Defined in: packages/mdkit/src/transport/backend.ts:55
Parameters
| Parameter | Type |
|---|---|
documentId | string |
Returns
| MdKitDocumentSnapshot
| Promise<MdKitDocumentSnapshot>
restoreDocumentVersion()?
optional restoreDocumentVersion(input: MdKitRestoreDocumentVersionInput):
| MdKitDocumentWriteResult
| Promise<MdKitDocumentWriteResult>;Defined in: packages/mdkit/src/transport/backend.ts:58
Parameters
| Parameter | Type |
|---|---|
input | MdKitRestoreDocumentVersionInput |
Returns
| MdKitDocumentWriteResult
| Promise<MdKitDocumentWriteResult>
writeCollaborationState()?
optional writeCollaborationState(documentName: string, state: Uint8Array): void | Promise<void>;Defined in: packages/mdkit/src/transport/backend.ts:61
Parameters
| Parameter | Type |
|---|---|
documentName | string |
state | Uint8Array |
Returns
void | Promise<void>
writeDocument()
writeDocument(input: MdKitDocumentWriteInput):
| MdKitDocumentWriteResult
| Promise<MdKitDocumentWriteResult>;Defined in: packages/mdkit/src/transport/backend.ts:65
Parameters
| Parameter | Type |
|---|---|
input | MdKitDocumentWriteInput |
Returns
| MdKitDocumentWriteResult
| Promise<MdKitDocumentWriteResult>