PersistenceBatchCommitRequest | @sheetwrite/core

Cancellable commit of one atomic batch that spans several server versions.

Source: packages/core/src/types/transaction.ts#L130

Members 6

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.

documentId

documentId: string;

baseVersion

baseVersion: number;

clientMutationId

clientMutationId: string;

operations

readonly operations: readonly DocumentOp[];

signal

signal?: AbortSignal;

Declaration

View full TypeScript declaration

export interface PersistenceBatchCommitRequest {
  readonly versionOperationCounts: readonly number[];
  documentId: string;
  baseVersion: number;
  clientMutationId: string;
  readonly operations: readonly DocumentOp[];
  signal?: AbortSignal;
}

Referenced by

Workspace packages depending on @sheetwrite/core

@sheetwrite/benchdependency
@sheetwrite/docs-startdependency
@sheetwrite/reactdependency
@sheetwrite/sveltedependency
@sheetwrite/vuedependency
@sheetwrite/xlsxdependency

Public exports naming PersistenceBatchCommitRequest

MemoryPersistenceAdapter@sheetwrite/core
PersistenceAdapter@sheetwrite/core

Loading documentation…