Queue, version, connection, or error transition emitted by synchronization.
Variants 13
clientMutationId: string;
clientMutationId?: string;
clientMutationId?: string;
Declaration
View full TypeScript declaration
export type SyncCoordinatorEvent =
clientMutationId: string;
clientMutationId?: string;
clientMutationId?: string;
Referenced by
Workspace packages depending on @sheetwrite/core
@sheetwrite/benchdependency
@sheetwrite/docs-startdependency
@sheetwrite/reactdependency
@sheetwrite/sveltedependency
@sheetwrite/vuedependency
@sheetwrite/xlsxdependency
Public exports naming SyncCoordinatorEvent
interface SyncStateSnapshot {
connection: SyncConnectionState;
activity: SyncActivityState;
pendingCount: number;
pendingOperations: number;
pendingEncodedBytes: number;
pendingCapacity: SyncPendingCapacityState;
serverVersion: number;
}interface SyncStateSnapshot {
connection: SyncConnectionState;
activity: SyncActivityState;
pendingCount: number;
pendingOperations: number;
pendingEncodedBytes: number;
pendingCapacity: SyncPendingCapacityState;
serverVersion: number;
}interface SyncStateSnapshot {
connection: SyncConnectionState;
activity: SyncActivityState;
pendingCount: number;
pendingOperations: number;
pendingEncodedBytes: number;
pendingCapacity: SyncPendingCapacityState;
serverVersion: number;
}Immutable observable synchronization state.API reference →interface SyncMutationRecord {
status: SyncMutationStatus;
documentId: string;
baseVersion: number;
clientMutationId: string;
readonly operations: readonly DocumentOp[];
readonly versionOperationCounts?: readonly number[];
}interface SyncMutationRecord {
status: SyncMutationStatus;
documentId: string;
baseVersion: number;
clientMutationId: string;
readonly operations: readonly DocumentOp[];
readonly versionOperationCounts?: readonly number[];
}interface SyncMutationRecord {
status: SyncMutationStatus;
documentId: string;
baseVersion: number;
clientMutationId: string;
readonly operations: readonly DocumentOp[];
readonly versionOperationCounts?: readonly number[];
}Pending commit paired with its current synchronization status.API reference →type PersistenceCommitResponse =
| { status: "applied"; version: number; clientMutationId: string }
| {
status: "duplicate";
version: number;
clientMutationId: string;
}
| {
status: "conflict";
currentVersion: number;
operationsSinceBase?: readonly VersionedOperation[];
snapshot?: WorkbookSnapshot;
};type PersistenceCommitResponse =
| { status: "applied"; version: number; clientMutationId: string }
| {
status: "duplicate";
version: number;
clientMutationId: string;
}
| {
status: "conflict";
currentVersion: number;
operationsSinceBase?: readonly VersionedOperation[];
snapshot?: WorkbookSnapshot;
};type PersistenceCommitResponse =
| {
status: "applied";
version: number;
clientMutationId: string;
}
| {
status: "duplicate";
version: number;
clientMutationId: string;
}
| {
status: "conflict";
currentVersion: number;
operationsSinceBase?: readonly VersionedOperation[];
snapshot?: WorkbookSnapshot;
};Applied, duplicate, or conflict acknowledgement from persistence. applied confirms the submitted operations unchanged; normalization must conflict.API reference →interface VersionedOperation {
version: number;
readonly operations: readonly DocumentOp[];
clientMutationId?: string;
batch?: VersionBatchMember;
}interface VersionedOperation {
version: number;
readonly operations: readonly DocumentOp[];
clientMutationId?: string;
batch?: VersionBatchMember;
}interface VersionedOperation {
version: number;
readonly operations: readonly DocumentOp[];
clientMutationId?: string;
batch?: VersionBatchMember;
}Remote document operations paired with a contiguous server version.API reference →interface WorkbookSnapshot {
schemaVersion: 1;
documentId?: string;
version?: number;
workbook: {
activeSheet: SheetId;
namedRanges?: NamedRangeSnapshot[];
};
sheets: SheetSnapshot[];
}interface WorkbookSnapshot {
schemaVersion: 1;
documentId?: string;
version?: number;
workbook: {
activeSheet: SheetId;
namedRanges?: NamedRangeSnapshot[];
};
sheets: SheetSnapshot[];
}interface WorkbookSnapshot {
schemaVersion: 1;
documentId?: string;
version?: number;
workbook: {
activeSheet: SheetId;
namedRanges?: NamedRangeSnapshot[];
};
sheets: SheetSnapshot[];
}Schema-versioned serializable workbook document.API reference →class SheetwriteError
extends Error
implements SheetwriteErrorEnvelope
{
constructor(
code: SheetwriteErrorCode,
operation: SheetwriteErrorOperation,
message: string,
options?: SheetwriteErrorOptions,
);
code:
| "aborted"
| "batch-limit"
| "blocked"
| "buffer-byte-limit"
// … 78 more lines — see the API reference
}class SheetwriteError
extends Error
implements SheetwriteErrorEnvelope
{
constructor(
code: SheetwriteErrorCode,
operation: SheetwriteErrorOperation,
message: string,
options?: SheetwriteErrorOptions,
);
code:
| "aborted"
| "batch-limit"
| "blocked"
| "buffer-byte-limit"
// … 78 more lines — see the API reference
}class SheetwriteError
extends Error
implements
SheetwriteErrorEnvelope
{
constructor(
code: SheetwriteErrorCode,
operation: SheetwriteErrorOperation,
message: string,
options?: SheetwriteErrorOptions,
);
code:
| "aborted"
| "batch-limit"
| "blocked"
| "buffer-byte-limit"
| "buffer-count-limit"
| "buffer-operation-limit"
| "comment-failed"
// … 80 more lines — see the API reference
}Canonical envelope for thrown and callback-delivered Sheetwrite failures.API reference →