TransactionApplicationOptions | @sheetwrite/core

Source and commit classification used when applying a transaction.

Package: @sheetwrite/core
Source: packages/core/src/types/transaction.ts#L59

Members 3

source Distinguishes host persistence input from local user/API output.

source?: OperationSourcetype OperationSource = "local" | "remote";type OperationSource = "local" | "remote";type OperationSource =
  "local" | "remote";Whether a committed change originated locally or from remote host input.API reference →;

commitReason Event classification; defaults to api.

commitReason?: CommitReasontype CommitReason =
  | "edit-blur"
  | "edit-enter"
  | "edit-tab"
  | "edit-programmatic"
  | "paste"
  | "cut"
  | "clear"
  | "fill"
  | "structure"
  | "style"
  | "replace"
  | "undo"
  | "redo"
  | "api";type CommitReason =
  | "edit-blur"
  | "edit-enter"
  | "edit-tab"
  | "edit-programmatic"
  | "paste"
  | "cut"
  | "clear"
  | "fill"
  | "structure"
  | "style"
  | "replace"
  | "undo"
  | "redo"
  | "api";type CommitReason =
  | "edit-blur"
  | "edit-enter"
  | "edit-tab"
  | "edit-programmatic"
  | "paste"
  | "cut"
  | "clear"
  | "fill"
  | "structure"
  | "style"
  | "replace"
  | "undo"
  | "redo"
  | "api";The gesture/operation that produced a committed transaction. Consumers switching on reasons MUST keep a default branch — the union grows with new mutation features.API reference →;

localReplay Internal durable-queue replay: bypass remote hydration while retaining remote event semantics.

localReplay?: boolean;

Declaration

View full TypeScript declaration

export interface TransactionApplicationOptions {
  source?: OperationSourcetype OperationSource = "local" | "remote";type OperationSource = "local" | "remote";type OperationSource =
  "local" | "remote";Whether a committed change originated locally or from remote host input.API reference →;
  commitReason?: CommitReasontype CommitReason =
  | "edit-blur"
  | "edit-enter"
  | "edit-tab"
  | "edit-programmatic"
  | "paste"
  | "cut"
  | "clear"
  | "fill"
  | "structure"
  | "style"
  | "replace"
  | "undo"
  | "redo"
  | "api";type CommitReason =
  | "edit-blur"
  | "edit-enter"
  | "edit-tab"
  | "edit-programmatic"
  | "paste"
  | "cut"
  | "clear"
  | "fill"
  | "structure"
  | "style"
  | "replace"
  | "undo"
  | "redo"
  | "api";type CommitReason =
  | "edit-blur"
  | "edit-enter"
  | "edit-tab"
  | "edit-programmatic"
  | "paste"
  | "cut"
  | "clear"
  | "fill"
  | "structure"
  | "style"
  | "replace"
  | "undo"
  | "redo"
  | "api";The gesture/operation that produced a committed transaction. Consumers switching on reasons MUST keep a default branch — the union grows with new mutation features.API reference →;
  localReplay?: boolean;
}