mirrors
/
mermaid
mirror of https://github.com/mermaid-js/mermaid.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #3768 from aloisklink/fix/fix-mermaid.render-types 

[9.2] fix(mermaid): fix `mermaid.render` types
This commit is contained in:
Sidharth Vinod 2022-11-07 14:01:37 +05:30 committed by GitHub
parent e78ac9b92a da6bb9498a
commit 41dbf0fa96
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -482,9 +482,9 @@ const parseAsync = (txt: string) => {
const renderAsync = ( const renderAsync = (
id: string, id: string,
text: string, text: string,
cb: (svgCode: string, bindFunctions?: (element: Element) => void) => void, cb?: (svgCode: string, bindFunctions?: (element: Element) => void) => void,
container?: Element container?: Element
): Promise<void> => { ): Promise<string> => {
return new Promise((resolve, reject) => { return new Promise((resolve, reject) => {
// This promise will resolve when the mermaidAPI.render call is done. // This promise will resolve when the mermaidAPI.render call is done.
// It will be queued first and will be executed when it is first in line // It will be queued first and will be executed when it is first in line

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

@ -115,19 +115,19 @@ export const decodeEntities = function (text: string): string {
* *
* @param {string} id The id of the element to be rendered * @param {string} id The id of the element to be rendered
* @param {string} text The graph definition * @param {string} text The graph definition
* @param {(svgCode: string, bindFunctions?: (element: Element) => void) => void} cb Callback which * @param cb - Optional callback which
* is called after rendering is finished with the svg code as inparam. * is called after rendering is finished with the svg code as inparam.
* @param {Element} container Selector to element in which a div with the graph temporarily will be * @param {Element} container Selector to element in which a div with the graph temporarily will be
* inserted. If one is provided a hidden div will be inserted in the body of the page instead. The * inserted. If one is provided a hidden div will be inserted in the body of the page instead. The
* element will be removed when rendering is completed. * element will be removed when rendering is completed.
* @returns {void} * @returns Returns the rendered element as a string containing the SVG definition.
*/ */
const render = function ( const render = function (
id: string, id: string,
text: string, text: string,
cb: (svgCode: string, bindFunctions?: (element: Element) => void) => void, cb?: (svgCode: string, bindFunctions?: (element: Element) => void) => void,
container?: Element container?: Element
): void { ): string {
addDiagrams(); addDiagrams();
configApi.reset(); configApi.reset();
text = text.replace(/\r\n?/g, '\n'); // parser problems on CRLF ignore all CR and leave LF;; text = text.replace(/\r\n?/g, '\n'); // parser problems on CRLF ignore all CR and leave LF;;
@ -401,9 +401,9 @@ const render = function (
const renderAsync = async function ( const renderAsync = async function (
id: string, id: string,
text: string, text: string,
cb: (svgCode: string, bindFunctions?: (element: Element) => void) => void, cb?: (svgCode: string, bindFunctions?: (element: Element) => void) => void,
container?: Element container?: Element
): Promise<void> { ): Promise<string> {
addDiagrams(); addDiagrams();
configApi.reset(); configApi.reset();
text = text.replace(/\r\n?/g, '\n'); // parser problems on CRLF ignore all CR and leave LF;; text = text.replace(/\r\n?/g, '\n'); // parser problems on CRLF ignore all CR and leave LF;;