Type Editor Documentation - 0.0.1

Appearance

Type Editor

Type Editor / @type-editor/model / replace

replace ​

Classes ​

ClassDescription

ReplaceError

Error type raised by Node.replace when given an invalid replacement.

This error is thrown when:

  • The slice's open depth is deeper than the insertion position
  • The open depths are inconsistent between start and end positions
  • Attempting to join incompatible node types
  • The range to remove or replace is not "flat" (spans incompatible node boundaries)

Example

typescript
try {
  node.replace(from, to, slice);
} catch (error) {
  if (error instanceof ReplaceError) {
    console.error("Invalid replacement:", error.message);
  }
}

Functions ​

FunctionDescription

replace

Replace a range of content between two resolved positions with a slice. This is the main entry point for performing document replacements.

Throws

If the slice's open depth is invalid or inconsistent with the positions.