mirror of
https://github.com/mermaid-js/mermaid.git
synced 2025-10-31 02:44:17 +01:00
64 lines
2.1 KiB
Markdown
64 lines
2.1 KiB
Markdown
> **Warning**
|
|
>
|
|
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
|
>
|
|
> ## Please edit the corresponding file in package/mermaid/src/docs.
|
|
|
|
# Module: mermaidAPI
|
|
|
|
## References
|
|
|
|
### <a id="default" name="default"></a> default
|
|
|
|
Renames and re-exports [mermaidAPI](mermaidAPI.md#mermaidapi)
|
|
|
|
## Variables
|
|
|
|
### <a id="mermaidapi" name="mermaidapi"></a> 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?`: `Function`) => `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](https://github.com/emersonbottero/mermaid/blob/c8b377bf/packages/mermaid/src/mermaidAPI.ts#L483)
|
|
|
|
## Functions
|
|
|
|
### <a id="decodeentities" name="decodeentities"></a> decodeEntities
|
|
|
|
▸ **decodeEntities**(`text`): `string`
|
|
|
|
#### Parameters
|
|
|
|
| Name | Type |
|
|
| :----- | :------- |
|
|
| `text` | `string` |
|
|
|
|
#### Returns
|
|
|
|
`string`
|
|
|
|
#### Defined in
|
|
|
|
[mermaidAPI.ts:73](https://github.com/emersonbottero/mermaid/blob/c8b377bf/packages/mermaid/src/mermaidAPI.ts#L73)
|
|
|
|
---
|
|
|
|
### <a id="encodeentities" name="encodeentities"></a> encodeEntities
|
|
|
|
▸ **encodeEntities**(`text`): `string`
|
|
|
|
#### Parameters
|
|
|
|
| Name | Type |
|
|
| :----- | :------- |
|
|
| `text` | `string` |
|
|
|
|
#### Returns
|
|
|
|
`string`
|
|
|
|
#### Defined in
|
|
|
|
[mermaidAPI.ts:47](https://github.com/emersonbottero/mermaid/blob/c8b377bf/packages/mermaid/src/mermaidAPI.ts#L47)
|