Type Editor / @type-editor/changeset / ChangeSet

ChangeSet

Classes

Class Description

Class	Description
ChangeSet	A change set tracks the changes to a document from a given point in the past. It condenses a number of step maps down to a flat sequence of replacements, and simplifies replacements that partially undo themselves by comparing their content. The ChangeSet maintains two coordinate systems: A coordinates: Positions in the original (starting) document B coordinates: Positions in the current (modified) document Example typescript // Create a changeset tracking from a document const changeSet = ChangeSet.create(startDoc); // Add steps as they occur const updated = changeSet.addSteps(newDoc, stepMaps, metadata); // Access the tracked changes for (const change of updated.changes) { console.log( `Replaced ${change.fromA}-${change.toA} with content at ${change.fromB}-${change.toB}`, ); }

A change set tracks the changes to a document from a given point in the past.

It condenses a number of step maps down to a flat sequence of replacements, and simplifies replacements that partially undo themselves by comparing their content.

The ChangeSet maintains two coordinate systems:

A coordinates: Positions in the original (starting) document
B coordinates: Positions in the current (modified) document

Example

typescript

// Create a changeset tracking from a document
const changeSet = ChangeSet.create(startDoc);

// Add steps as they occur
const updated = changeSet.addSteps(newDoc, stepMaps, metadata);

// Access the tracked changes
for (const change of updated.changes) {
  console.log(
    `Replaced ${change.fromA}-${change.toA} with content at ${change.fromB}-${change.toB}`,
  );
}

ChangeSet ​

Classes ​

ChangeSet

Classes