mermaid/docs/config/setup/modules/mermaidAPI.md

Warning

THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.

Please edit the corresponding file in package/mermaid/src/docs.

Module: mermaidAPI

References

default

Renames and re-exports mermaidAPI

Variables

mermaidAPI

• Const mermaidAPI: Readonly<{ defaultConfig: MermaidConfig = configApi.defaultConfig; getConfig: () => MermaidConfig = configApi.getConfig; getSiteConfig: () => MermaidConfig = configApi.getSiteConfig; globalReset: () => void ; initialize: (options: MermaidConfig) => Promise<void> ; parse: (text: string, parseError?: ParseErrorFunction) => boolean ; parseDirective: (p: any, statement: string, context: string, type: string) => void ; render: (id: string, text: string, cb: (svgCode: string, bindFunctions?: (element: Element) => void) => void, container?: Element) => Promise<void> ; reset: () => void ; setConfig: (conf: MermaidConfig) => MermaidConfig = configApi.setConfig; updateSiteConfig: (conf: MermaidConfig) => MermaidConfig = configApi.updateSiteConfig }>

Defined in

mermaidAPI.ts:483

Functions

decodeEntities

▸ decodeEntities(text): string

Parameters

Name	Type
text	string

Returns

string

Defined in

mermaidAPI.ts:70

---

encodeEntities

▸ encodeEntities(text): string

Parameters

Name	Type
text	string

Returns

string

Defined in

mermaidAPI.ts:44