SheetwriteStoreOptions | @sheetwrite/core

Storage layout plus snapshot and transaction resource ceilings for one store.

Source: packages/core/src/store.ts#L71

Members 9

snapshotResourceLimits Overrides canonical snapshot/workbook allocation ceilings before construction.

snapshotResourceLimits?: Partial<SnapshotResourceLimits>;

transactionResourceLimits Overrides inclusive operation-count and encoded-byte ceilings for every transaction.

transactionResourceLimits?: Partial<TransactionResourceLimits>;

storage SnapshotStorageMode Storage engine; defaults to eager dense allocation.

storage?: SnapshotStorageMode;

chunkRows Paged row chunk size; defaults to 4,096 and is normalized to a power of two.

chunkRows?: number;

cacheBytes Per-sheet clean-chunk budget; defaults to 32 MiB.

cacheBytes?: number;

Per-sheet clean-chunk budget; defaults to 32 MiB. Dirty and pinned chunks may exceed it.

dirtyCellLimit Maximum sparse local edits retained outside the clean page cache.

dirtyCellLimit?: number;

Maximum sparse local edits retained outside the clean page cache. Defaults to 1,000,000 cells; further edits reject atomically.

referenceSimulationLimit Maximum clean references retained for exact multi-operation remove-sheet simulation.

referenceSimulationLimit?: number;

protectionResolver

protectionResolver?: ProtectionResolver;

mutationPolicy

mutationPolicy?: MutationPolicyMode;

Declaration

View full TypeScript declaration

export interface SheetwriteStoreOptions {
  snapshotResourceLimits?: Partial<SnapshotResourceLimits>;
  transactionResourceLimits?: Partial<TransactionResourceLimits>;
  storage?: "dense" | "paged";
  chunkRows?: number;
  cacheBytes?: number;
  dirtyCellLimit?: number;
  referenceSimulationLimit?: number;
  protectionResolver?: ProtectionResolver;
  mutationPolicy?: MutationPolicyMode;
}

Referenced by

Workspace packages depending on @sheetwrite/core

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

Public exports naming SheetwriteStoreOptions

SheetwriteStore@sheetwrite/core

Loading documentation…