MdKitTransportStore
Type Alias: MdKitTransportStore
type MdKitTransportStore = {
readDocument: | MdKitDocumentSnapshot
| Promise<MdKitDocumentSnapshot>;
writeDocument: | MdKitDocumentWriteResult
| Promise<MdKitDocumentWriteResult>;
resyncDocument?: | MdKitDocumentSnapshot
| Promise<MdKitDocumentSnapshot>;
listDocumentVersions?: | MdKitDocumentVersionSummary[]
| Promise<MdKitDocumentVersionSummary[]>;
readDocumentVersion?: | MdKitDocumentVersionDetail
| Promise<
| MdKitDocumentVersionDetail
| null>
| null;
restoreDocumentVersion?: | MdKitDocumentWriteResult
| Promise<MdKitDocumentWriteResult>;
readCollaborationState?: | Uint8Array<ArrayBufferLike>
| Promise<Uint8Array<ArrayBufferLike> | null>
| null;
writeCollaborationState?: void | Promise<void>;
};Defined in: packages/mdkit/src/transport/store.ts:9
Methods
readDocument()
readDocument(documentId: string):
| MdKitDocumentSnapshot
| Promise<MdKitDocumentSnapshot>;Defined in: packages/mdkit/src/transport/store.ts:10
Parameters
| Parameter | Type |
|---|---|
documentId | string |
Returns
| MdKitDocumentSnapshot
| Promise<MdKitDocumentSnapshot>
writeDocument()
writeDocument(input: MdKitDocumentWriteInput):
| MdKitDocumentWriteResult
| Promise<MdKitDocumentWriteResult>;Defined in: packages/mdkit/src/transport/store.ts:13
Parameters
| Parameter | Type |
|---|---|
input | MdKitDocumentWriteInput |
Returns
| MdKitDocumentWriteResult
| Promise<MdKitDocumentWriteResult>
resyncDocument()?
optional resyncDocument(documentId: string):
| MdKitDocumentSnapshot
| Promise<MdKitDocumentSnapshot>;Defined in: packages/mdkit/src/transport/store.ts:16
Parameters
| Parameter | Type |
|---|---|
documentId | string |
Returns
| MdKitDocumentSnapshot
| Promise<MdKitDocumentSnapshot>
listDocumentVersions()?
optional listDocumentVersions(documentId: string):
| MdKitDocumentVersionSummary[]
| Promise<MdKitDocumentVersionSummary[]>;Defined in: packages/mdkit/src/transport/store.ts:19
Parameters
| Parameter | Type |
|---|---|
documentId | string |
Returns
| MdKitDocumentVersionSummary[]
| Promise<MdKitDocumentVersionSummary[]>
readDocumentVersion()?
optional readDocumentVersion(input: {
documentId: string;
versionId: string;
}):
| MdKitDocumentVersionDetail
| Promise<
| MdKitDocumentVersionDetail
| null>
| null;Defined in: packages/mdkit/src/transport/store.ts:22
Parameters
| Parameter | Type |
|---|---|
input | { documentId: string; versionId: string; } |
input.documentId | string |
input.versionId | string |
Returns
| MdKitDocumentVersionDetail
| Promise<
| MdKitDocumentVersionDetail
| null>
| null
restoreDocumentVersion()?
optional restoreDocumentVersion(input: {
documentId: string;
versionId: string;
}):
| MdKitDocumentWriteResult
| Promise<MdKitDocumentWriteResult>;Defined in: packages/mdkit/src/transport/store.ts:29
Parameters
| Parameter | Type |
|---|---|
input | { documentId: string; versionId: string; } |
input.documentId | string |
input.versionId | string |
Returns
| MdKitDocumentWriteResult
| Promise<MdKitDocumentWriteResult>
readCollaborationState()?
optional readCollaborationState(documentName: string):
| Uint8Array<ArrayBufferLike>
| Promise<Uint8Array<ArrayBufferLike> | null>
| null;Defined in: packages/mdkit/src/transport/store.ts:33
Parameters
| Parameter | Type |
|---|---|
documentName | string |
Returns
| Uint8Array<ArrayBufferLike>
| Promise<Uint8Array<ArrayBufferLike> | null>
| null
writeCollaborationState()?
optional writeCollaborationState(documentName: string, state: Uint8Array): void | Promise<void>;Defined in: packages/mdkit/src/transport/store.ts:36
Parameters
| Parameter | Type |
|---|---|
documentName | string |
state | Uint8Array |
Returns
void | Promise<void>