Rich text / foldkit-richtext

TransformReport

interface · packages/richtext/src/transform.ts:24

interface TransformReport {
  readonly document: Document
  readonly steps: ReadonlyArray<
    PositionStep | SplitStep | RelocateStep | CollapseStep
  >
  readonly insertedNodes: ReadonlySet<NodeId>
  readonly removedNodes: ReadonlySet<NodeId>
  readonly dirtyNodes: ReadonlySet<NodeId>
  readonly textChanged: ReadonlySet<NodeId>
  readonly structureChanged: boolean
}

Members

TransformReport.document

property · packages/richtext/src/transform.ts:25

readonly document: Document

TransformReport.steps

property · packages/richtext/src/transform.ts:27

readonly steps: ReadonlyArray<
  PositionStep | SplitStep | RelocateStep | CollapseStep
>

The same step vocabulary a transaction uses, so apply can fold either.

TransformReport.insertedNodes

property · packages/richtext/src/transform.ts:28

readonly insertedNodes: ReadonlySet<NodeId>

TransformReport.removedNodes

property · packages/richtext/src/transform.ts:29

readonly removedNodes: ReadonlySet<NodeId>

TransformReport.dirtyNodes

property · packages/richtext/src/transform.ts:30

readonly dirtyNodes: ReadonlySet<NodeId>

TransformReport.textChanged

property · packages/richtext/src/transform.ts:32

readonly textChanged: ReadonlySet<NodeId>

Runs whose text a transform rewrote, such as a merge's accumulator.

TransformReport.structureChanged

property · packages/richtext/src/transform.ts:34

readonly structureChanged: boolean

Whether the block list changed shape, not just the runs inside a block.