Class: SourceDocument

Defined in: package/headless/dist/source/source-document.d.ts:30

Constructors

new SourceDocument(source, diagramType): SourceDocument

Defined in: package/headless/dist/source/source-document.d.ts:41

Analyzes source regions for safe mutations of the specified diagram type.

Parameter	Type	Description
`source`	`string`	Mermaid source to inspect.
`diagramType`	`DiagramType`	Diagram type used to classify source regions.

SourceDocument

readonly diagramType: DiagramType

Defined in: package/headless/dist/source/source-document.d.ts:34

Diagram type used to classify source regions.

readonly regions: readonly SourceRegion[]

Defined in: package/headless/dist/source/source-document.d.ts:36

Source spans, including statements, comments, metadata, and opaque text.

readonly source: string

Defined in: package/headless/dist/source/source-document.d.ts:32

Original Mermaid source.

findUniqueEditableStatement(statement): SourceRegion

Defined in: package/headless/dist/source/source-document.d.ts:51

Finds an editable statement and requires exactly one match.

Parameter	Type	Description
`statement`	`string`	Exact statement text to find.

SourceRegion

replaceStatement(start, end, replacement): string

Defined in: package/headless/dist/source/source-document.d.ts:47

Replaces one safe flowchart node statement at the given source offsets.

Parameter	Type	Description
`start`	`number`	Inclusive start offset of the statement.
`end`	`number`	Exclusive end offset of the statement.
`replacement`	`string`	Replacement statement text.

string

serializeMutation(candidate): string

Defined in: package/headless/dist/source/source-document.d.ts:55

Serializes a candidate mutation while preserving protected source regions.

Parameter	Type	Description
`candidate`	`string`	Candidate Mermaid source after a mutation.

string