mermaid/docs/config/setup/interfaces/mermaid.ParseResult.md

Warning

THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.

Please edit the corresponding file in /packages/mermaid/src/docs/config/setup/interfaces/mermaid.ParseResult.md.

Interface: ParseResult

mermaid.ParseResult

Properties

code

• code: string

The mermaid code after extracting the config.

Defined in

packages/mermaid/src/types.ts:66

---

config

• config: MermaidConfig

The config passed as YAML frontmatter or directives

Defined in

packages/mermaid/src/types.ts:70

---

diagram

• Optional diagram: Diagram

Defined in

packages/mermaid/src/types.ts:72

---

error

• Optional error: unknown

The error that occurred during parsing, if any.

Defined in

packages/mermaid/src/types.ts:76

---

success

• success: boolean

Defined in

packages/mermaid/src/types.ts:62

---

title

• Optional title: string

Defined in

packages/mermaid/src/types.ts:71