@sheetwrite/coretype
Outcome of applying a document transaction, including conflict, rejection, and no-op states.
- Package
@sheetwrite/core- Source
packages/core/src/types/transaction.ts#L35
Variants 4
{ status: "applied"; epoch: number; transaction: Transactioninterface Transaction {
patches: DocumentOp[];
epoch?: number;
}interface Transaction {
patches: DocumentOp[];
epoch?: number;
}interface Transaction {
patches: DocumentOp[];
epoch?: number;
}Low-level Store transaction. epoch provides optional optimistic concurrency at the storage boundary. Calling Store.applyTransaction bypasses Grid read-only checks and Grid undo/redo history. Host-driven edits should use Grid.applyTransaction.API reference →; warnings?: MutationIssuetype MutationIssue =
| {
kind: "validation";
severity: "error" | "warning";
ruleId: string;
addr: CellAddress;
value: CellValue;
message: string;
operationIndex: number;
}
| {
kind: "protection";
severity: "error";
protectedRangeId: string;
range: Range;
// … 16 more lines — see the API reference
}type MutationIssue =
| {
kind: "validation";
severity: "error" | "warning";
ruleId: string;
addr: CellAddress;
value: CellValue;
message: string;
operationIndex: number;
}
| {
kind: "protection";
severity: "error";
protectedRangeId: string;
range: Range;
// … 16 more lines — see the API reference
}type MutationIssue =
| {
kind: "validation";
severity:
"error" | "warning";
ruleId: string;
addr: CellAddress;
value: CellValue;
message: string;
operationIndex: number;
}
| {
kind: "protection";
severity: "error";
protectedRangeId: string;
range: Range;
operationIndex: number;
message: string;
}
// … 13 more lines — see the API reference
}Structured warning or rejection produced while applying an operation.API reference →[]; rejections?: MutationIssuetype MutationIssue =
| {
kind: "validation";
severity: "error" | "warning";
ruleId: string;
addr: CellAddress;
value: CellValue;
message: string;
operationIndex: number;
}
| {
kind: "protection";
severity: "error";
protectedRangeId: string;
range: Range;
// … 16 more lines — see the API reference
}type MutationIssue =
| {
kind: "validation";
severity: "error" | "warning";
ruleId: string;
addr: CellAddress;
value: CellValue;
message: string;
operationIndex: number;
}
| {
kind: "protection";
severity: "error";
protectedRangeId: string;
range: Range;
// … 16 more lines — see the API reference
}type MutationIssue =
| {
kind: "validation";
severity:
"error" | "warning";
ruleId: string;
addr: CellAddress;
value: CellValue;
message: string;
operationIndex: number;
}
| {
kind: "protection";
severity: "error";
protectedRangeId: string;
range: Range;
operationIndex: number;
message: string;
}
// … 13 more lines — see the API reference
}Structured warning or rejection produced while applying an operation.API reference →[];}{ status: "conflict"; expectedEpoch: number; actualEpoch: number;}{ status: "rejected"; epoch: number; issues: MutationIssuetype MutationIssue =
| {
kind: "validation";
severity: "error" | "warning";
ruleId: string;
addr: CellAddress;
value: CellValue;
message: string;
operationIndex: number;
}
| {
kind: "protection";
severity: "error";
protectedRangeId: string;
range: Range;
// … 16 more lines — see the API reference
}type MutationIssue =
| {
kind: "validation";
severity: "error" | "warning";
ruleId: string;
addr: CellAddress;
value: CellValue;
message: string;
operationIndex: number;
}
| {
kind: "protection";
severity: "error";
protectedRangeId: string;
range: Range;
// … 16 more lines — see the API reference
}type MutationIssue =
| {
kind: "validation";
severity:
"error" | "warning";
ruleId: string;
addr: CellAddress;
value: CellValue;
message: string;
operationIndex: number;
}
| {
kind: "protection";
severity: "error";
protectedRangeId: string;
range: Range;
operationIndex: number;
message: string;
}
// … 13 more lines — see the API reference
}Structured warning or rejection produced while applying an operation.API reference →[];}{ status: "noop"; epoch: number; reason: "empty" | "out-of-bounds" | "incomplete-data" | "read-only";}Declaration
View full TypeScript declaration
export type ApplyTransactionResult = | { status: "applied"; epoch: number; transaction: Transactioninterface Transaction {
patches: DocumentOp[];
epoch?: number;
}interface Transaction {
patches: DocumentOp[];
epoch?: number;
}interface Transaction {
patches: DocumentOp[];
epoch?: number;
}Low-level Store transaction. epoch provides optional optimistic concurrency at the storage boundary. Calling Store.applyTransaction bypasses Grid read-only checks and Grid undo/redo history. Host-driven edits should use Grid.applyTransaction.API reference →; warnings?: MutationIssuetype MutationIssue =
| {
kind: "validation";
severity: "error" | "warning";
ruleId: string;
addr: CellAddress;
value: CellValue;
message: string;
operationIndex: number;
}
| {
kind: "protection";
severity: "error";
protectedRangeId: string;
range: Range;
// … 16 more lines — see the API reference
}type MutationIssue =
| {
kind: "validation";
severity: "error" | "warning";
ruleId: string;
addr: CellAddress;
value: CellValue;
message: string;
operationIndex: number;
}
| {
kind: "protection";
severity: "error";
protectedRangeId: string;
range: Range;
// … 16 more lines — see the API reference
}type MutationIssue =
| {
kind: "validation";
severity:
"error" | "warning";
ruleId: string;
addr: CellAddress;
value: CellValue;
message: string;
operationIndex: number;
}
| {
kind: "protection";
severity: "error";
protectedRangeId: string;
range: Range;
operationIndex: number;
message: string;
}
// … 13 more lines — see the API reference
}Structured warning or rejection produced while applying an operation.API reference →[]; rejections?: MutationIssuetype MutationIssue =
| {
kind: "validation";
severity: "error" | "warning";
ruleId: string;
addr: CellAddress;
value: CellValue;
message: string;
operationIndex: number;
}
| {
kind: "protection";
severity: "error";
protectedRangeId: string;
range: Range;
// … 16 more lines — see the API reference
}type MutationIssue =
| {
kind: "validation";
severity: "error" | "warning";
ruleId: string;
addr: CellAddress;
value: CellValue;
message: string;
operationIndex: number;
}
| {
kind: "protection";
severity: "error";
protectedRangeId: string;
range: Range;
// … 16 more lines — see the API reference
}type MutationIssue =
| {
kind: "validation";
severity:
"error" | "warning";
ruleId: string;
addr: CellAddress;
value: CellValue;
message: string;
operationIndex: number;
}
| {
kind: "protection";
severity: "error";
protectedRangeId: string;
range: Range;
operationIndex: number;
message: string;
}
// … 13 more lines — see the API reference
}Structured warning or rejection produced while applying an operation.API reference →[]; } | { status: "conflict"; expectedEpoch: number; actualEpoch: number; } | { status: "rejected"; epoch: number; issues: MutationIssuetype MutationIssue =
| {
kind: "validation";
severity: "error" | "warning";
ruleId: string;
addr: CellAddress;
value: CellValue;
message: string;
operationIndex: number;
}
| {
kind: "protection";
severity: "error";
protectedRangeId: string;
range: Range;
// … 16 more lines — see the API reference
}type MutationIssue =
| {
kind: "validation";
severity: "error" | "warning";
ruleId: string;
addr: CellAddress;
value: CellValue;
message: string;
operationIndex: number;
}
| {
kind: "protection";
severity: "error";
protectedRangeId: string;
range: Range;
// … 16 more lines — see the API reference
}type MutationIssue =
| {
kind: "validation";
severity:
"error" | "warning";
ruleId: string;
addr: CellAddress;
value: CellValue;
message: string;
operationIndex: number;
}
| {
kind: "protection";
severity: "error";
protectedRangeId: string;
range: Range;
operationIndex: number;
message: string;
}
// … 13 more lines — see the API reference
}Structured warning or rejection produced while applying an operation.API reference →[]; } | { status: "noop"; epoch: number; reason: "empty" | "out-of-bounds" | "incomplete-data" | "read-only"; };