mirror of
https://github.com/mermaid-js/mermaid.git
synced 2025-09-20 15:59:51 +02:00
76 lines
1.6 KiB
Markdown
76 lines
1.6 KiB
Markdown
> **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](../../../../packages/mermaid/src/docs/config/setup/interfaces/mermaid.ParseResult.md).
|
|
|
|
# Interface: ParseResult
|
|
|
|
[mermaid](../modules/mermaid.md).ParseResult
|
|
|
|
## Properties
|
|
|
|
### code
|
|
|
|
• **code**: `string`
|
|
|
|
The mermaid code after extracting the config.
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/types.ts:69](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/types.ts#L69)
|
|
|
|
---
|
|
|
|
### config
|
|
|
|
• **config**: [`MermaidConfig`](mermaid.MermaidConfig.md)
|
|
|
|
The config passed as YAML frontmatter or directives
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/types.ts:73](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/types.ts#L73)
|
|
|
|
---
|
|
|
|
### diagram
|
|
|
|
• `Optional` **diagram**: `Diagram`
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/types.ts:75](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/types.ts#L75)
|
|
|
|
---
|
|
|
|
### error
|
|
|
|
• `Optional` **error**: `unknown`
|
|
|
|
The error that occurred during parsing, if any.
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/types.ts:79](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/types.ts#L79)
|
|
|
|
---
|
|
|
|
### success
|
|
|
|
• **success**: `boolean`
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/types.ts:65](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/types.ts#L65)
|
|
|
|
---
|
|
|
|
### title
|
|
|
|
• `Optional` **title**: `string`
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/types.ts:74](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/types.ts#L74)
|