Skip to content

Mermaid.parse method

Mermaid › parse

Unofficial

Parse a Mermaid diagram definition.

Signature:

parse(text: string, parseOptions?: ParseOptions | undefined): Promise<false | ParseResult>

Parameters:

Parameter Type Description
text string The diagram text to parse.
parseOptions? ParseOptions | undefined Options for parsing.

Returns: Promise<false | ParseResult>A promise resolving to the parse result, or false if parsing failed.