marcel/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-09-23 09:20:03 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs(mermaid): document initThrowsErrorsAsync

Browse Source 
Add some basic tsdoc for initThrowsErrorsAsync.
This commit is contained in:
Alois Klink
2022-10-20 10:53:08 +01:00
parent 327fcbf902
commit 13110c4ed9
1 changed files with 13 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -217,9 +217,20 @@ const loadExternalDiagrams = async (conf: MermaidConfig) => {
};
/**
* @deprecated This is an internal function and should not be used. Will be removed in v10.
* Equivalent to {@link init()}, except an error will be thrown on error.
*
* @alpha
* @deprecated This is an internal function and will very likely be modified in v10, or earlier.
* We recommend staying with {@link initThrowsErrors} if you don't need `lazyLoadedDiagrams`.
*
* @param config - **Deprecated** Mermaid sequenceConfig.
* @param nodes - One of:
* - A DOM Node
* - An array of DOM nodes (as would come from a jQuery selector)
* - A W3C selector, a la `.mermaid` (default)
* @param callback - Function that is called with the id of each generated mermaid diagram.
* @returns Resolves on success, otherwise the {@link Promise} will be rejected with an Error.
*/
const initThrowsErrorsAsync = async function (
config?: MermaidConfig,
// eslint-disable-next-line no-undef