marcel/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-11-06 13:54:09 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'sidv/diagramType' of https://github.com/mermaid-js/mermaid into sidv/diagramType

Browse Source 
* 'sidv/diagramType' of https://github.com/mermaid-js/mermaid:
  Update docs
  Update packages/mermaid/src/docs/config/usage.md
This commit is contained in:
Sidharth Vinod
2023-12-08 09:57:33 +05:30
parent b8470a471b 45880395ea
commit edf32911be
2 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/config/usage.md
View File

@@ -337,9 +337,9 @@ The `mermaid.parse(text, parseOptions)` function validates graph definitions wit
The function `mermaid.parse(text, parseOptions)`, takes a text string as an argument and returns `{ diagramType: string }` if the definition follows mermaid's syntax. The function `mermaid.parse(text, parseOptions)`, takes a text string as an argument and returns `{ diagramType: string }` if the definition follows mermaid's syntax.
If the definition is invalid, the function returns `false` if `parseOptions.supressError` is set to `true`. Otherwise, it throws an error. If the definition is invalid, the function returns `false` if `parseOptions.suppressErrors` is set to `true`. Otherwise, it throws an error.
The parseError function will be called when the parse function throws an error. It will not be called if `parseOptions.supressError` is set to `true`. The parseError function will be called when the parse function throws an error. It will not be called if `parseOptions.suppressErrors` is set to `true`.
It is possible to override this function in order to handle the error in an application-specific way. It is possible to override this function in order to handle the error in an application-specific way.

4
packages/mermaid/src/docs/config/usage.md
View File

@@ -334,9 +334,9 @@ The `mermaid.parse(text, parseOptions)` function validates graph definitions wit
The function `mermaid.parse(text, parseOptions)`, takes a text string as an argument and returns `{ diagramType: string }` if the definition follows mermaid's syntax. The function `mermaid.parse(text, parseOptions)`, takes a text string as an argument and returns `{ diagramType: string }` if the definition follows mermaid's syntax.
If the definition is invalid, the function returns `false` if `parseOptions.supressError` is set to `true`. Otherwise, it throws an error. If the definition is invalid, the function returns `false` if `parseOptions.suppressErrors` is set to `true`. Otherwise, it throws an error.
The parseError function will be called when the parse function throws an error. It will not be called if `parseOptions.supressError` is set to `true`. The parseError function will be called when the parse function throws an error. It will not be called if `parseOptions.suppressErrors` is set to `true`.
It is possible to override this function in order to handle the error in an application-specific way. It is possible to override this function in order to handle the error in an application-specific way.