SyncCoordinatorLimits | @sheetwrite/core

Resource ceilings applied independently to remote collaboration input and local durability.

Source: packages/core/src/sync.ts#L122

Members 13

maxMutationIdBytes UTF-8 bytes in a remote or pending mutation ID; defaults to 256.

maxMutationIdBytes: number;

maxOperationsPerVersion Operations accepted in one remote version; defaults to 10,000.

maxOperationsPerVersion: number;

maxVersionPayloadBytes Encoded operation bytes accepted in one remote version; defaults to 8 MiB.

maxVersionPayloadBytes: number;

maxFutureVersionDistance Version distance allowed ahead of the contiguous head; defaults to 1,024.

maxFutureVersionDistance: number;

maxBufferedVersions Remote future versions retained in the gap buffer; defaults to 256.

maxBufferedVersions: number;

maxBufferedOperations Aggregate operations retained in the gap buffer; defaults to 40,000.

maxBufferedOperations: number;

maxBufferedBytes Aggregate encoded bytes retained in the gap buffer; defaults to 32 MiB.

maxBufferedBytes: number;

maxRecentAcknowledgements Recently acknowledged mutation IDs retained for echo deduplication; defaults to 4,096.

maxRecentAcknowledgements: number;

Recently acknowledged mutation IDs retained for echo deduplication; defaults to 4,096. Once an ID expires, a stale operation carrying it is a reload-requiring protocol violation and its operations are never reapplied.

maxBatchVersions Versions in one atomic batch, sent or received; defaults to and cannot exceed 16.

maxBatchVersions: number;

Versions in one atomic batch, sent or received; defaults to and cannot exceed 16. Each member version stays within the per-version limits.

maxBatchBytes Aggregate encoded operation bytes in one atomic batch, sent or received; defaults to and cannot exceed 64 MiB.

maxBatchBytes: number;

maxPendingCommits Pending local commits, including synchronous reservations; defaults to 10,000.

maxPendingCommits: number;

maxPendingOperations Aggregate DocumentOp count across pending commits; defaults to 100,000.

maxPendingOperations: number;

maxPendingEncodedBytes Aggregate UTF-8 bytes across pending operation arrays; defaults to 128 MiB.

maxPendingEncodedBytes: number;

Declaration

View full TypeScript declaration

export interface SyncCoordinatorLimits {
  maxMutationIdBytes: number;
  maxOperationsPerVersion: number;
  maxVersionPayloadBytes: number;
  maxFutureVersionDistance: number;
  maxBufferedVersions: number;
  maxBufferedOperations: number;
  maxBufferedBytes: number;
  maxRecentAcknowledgements: number;
  maxBatchVersions: number;
  maxBatchBytes: number;
  maxPendingCommits: number;
  maxPendingOperations: number;
  maxPendingEncodedBytes: 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 SyncCoordinatorLimits

DEFAULT_SYNC_COORDINATOR_LIMITS@sheetwrite/core
SyncCoordinatorOptions@sheetwrite/core

Loading documentation…