marcel/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-10-04 06:39:40 +02:00
Code Issues Packages Projects Releases Wiki Activity

chore: Add docs

Browse Source
This commit is contained in:
Sidharth Vinod
2023-12-08 10:06:36 +05:30
parent edf32911be
commit b9bc518a0a
3 changed files with 22 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
packages/mermaid/src/mermaid.ts
View File

@@ -314,9 +314,21 @@ const executeQueue = async () => {
/**
* Parse the text and validate the syntax.
* @param text - The mermaid diagram definition.
* @param parseOptions - Options for parsing.
* @returns An object with the diagramType set to type of the diagram if valid. Otherwise false if parseOptions.suppressErrors is true.
* @param parseOptions - Options for parsing. @see {@link ParseOptions}
* @returns If valid, {@link ParseResult} otherwise `false` if parseOptions.suppressErrors is `true`.
* @throws Error if the diagram is invalid and parseOptions.suppressErrors is false or not set.
*
* @example
* ```js
* console.log(await mermaid.parse('flowchart \n a --> b'));
* // { diagramType: 'flowchart-v2' }
* console.log(await mermaid.parse('wrong \n a --> b', { suppressErrors: true }));
* // false
* console.log(await mermaid.parse('wrong \n a --> b', { suppressErrors: false }));
* // throws Error
* console.log(await mermaid.parse('wrong \n a --> b'));
* // throws Error
* ```
*/
const parse: typeof mermaidAPI.parse = async (text, parseOptions) => {
return new Promise((resolve, reject) => {

1
packages/mermaid/src/mermaidAPI.ts
View File

@@ -108,7 +108,6 @@ function processAndSetConfigs(text: string) {
* @returns An object with the `diagramType` set to type of the diagram if valid. Otherwise `false` if parseOptions.suppressErrors is `true`.
* @throws Error if the diagram is invalid and parseOptions.suppressErrors is false or not set.
*/
async function parse(
text: string,
parseOptions: ParseOptions & { suppressErrors: true }