Pending commit paired with its current synchronization status.
Members 6
status
documentId
baseVersion
clientMutationIdclientMutationId : string;
operations
versionOperationCounts Present only when the operations are too large for one server version. readonly versionOperationCounts ?: readonly number[];
Present only when the operations are too large for one server version.
Each entry is the operation count of one consecutive version of an atomic
batch, in order; the counts add up to `operations.length`. A server
applies and publishes all of these versions, or none of them.
Declaration
View full TypeScript declaration
export interface SyncMutationRecord {
clientMutationId : string ;
readonly versionOperationCounts ?: readonly number [];
Referenced by
Workspace packages depending on @sheetwrite/core
@sheetwrite/benchdependency @sheetwrite/docs-startdependency @sheetwrite/reactdependency @sheetwrite/sveltedependency @sheetwrite/vuedependency @sheetwrite/xlsxdependency
Public exports naming SyncMutationRecord
type SyncMutationStatus =
| "persisting"
| "pending"
| "sending"
| "conflicted"
| "storage-error"; type SyncMutationStatus = | "persisting" | "pending" | "sending" | "conflicted" | "storage-error" ; type SyncMutationStatus = | "persisting" | "pending" | "sending" | "conflicted" | "storage-error" ; Lifecycle state of one local mutation in the synchronization queue. API reference → type DocumentOp =
| {
op: "set";
addr: CellAddress;
value: CellValue;
style?: CellStyle;
}
| { op: "setRange"; range: Range; cells: SnapshotCell[] }
| { op: "setBlock"; range: Range; block: PackedCellBlock }
| {
op: "restoreBlock";
range: Range;
encoding: "deflate-json-v1";
decodedBytes: number;
data: string;
// … 100 more lines — see the API reference
} type DocumentOp = | { op : "set" ; addr : CellAddress ; value : CellValue ; style ?: CellStyle ; } | { op : "setRange" ; range : Range ; cells : SnapshotCell [] } | { op : "setBlock" ; range : Range ; block : PackedCellBlock } | { op : "restoreBlock" ; range : Range ; encoding : "deflate-json-v1" ; decodedBytes : number ; data : string ; // … 100 more lines — see the API reference } type DocumentOp = | { op : "set" ; addr : CellAddress ; value : CellValue ; style ?: CellStyle ; } | { op : "setRange" ; range : Range ; cells : SnapshotCell []; } | { op : "setBlock" ; range : Range ; block : PackedCellBlock ; } | { op : "restoreBlock" ; // … 175 more lines — see the API reference } Exhaustive serializable operation union for workbook mutations. API reference →