mirror of
https://github.com/mermaid-js/mermaid.git
synced 2025-11-04 04:44:08 +01:00
58 lines
1.8 KiB
Markdown
58 lines
1.8 KiB
Markdown
> **Warning**
|
|
>
|
|
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
|
>
|
|
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/modules/mermaid.md](../../../../packages/mermaid/src/docs/config/setup/modules/mermaid.md).
|
|
|
|
# Module: mermaid
|
|
|
|
## Classes
|
|
|
|
- [UnknownDiagramError](../classes/mermaid.UnknownDiagramError.md)
|
|
|
|
## Interfaces
|
|
|
|
- [DetailedError](../interfaces/mermaid.DetailedError.md)
|
|
- [ExternalDiagramDefinition](../interfaces/mermaid.ExternalDiagramDefinition.md)
|
|
- [Mermaid](../interfaces/mermaid.Mermaid.md)
|
|
- [MermaidConfig](../interfaces/mermaid.MermaidConfig.md)
|
|
- [ParseOptions](../interfaces/mermaid.ParseOptions.md)
|
|
- [ParseResult](../interfaces/mermaid.ParseResult.md)
|
|
- [RenderResult](../interfaces/mermaid.RenderResult.md)
|
|
- [RunOptions](../interfaces/mermaid.RunOptions.md)
|
|
|
|
## Type Aliases
|
|
|
|
### ParseErrorFunction
|
|
|
|
Ƭ **ParseErrorFunction**: (`err`: `string` | [`DetailedError`](../interfaces/mermaid.DetailedError.md) | `unknown`, `hash?`: `any`) => `void`
|
|
|
|
#### Type declaration
|
|
|
|
▸ (`err`, `hash?`): `void`
|
|
|
|
##### Parameters
|
|
|
|
| Name | Type |
|
|
| :------ | :--------------------------------------------------------------------------------- |
|
|
| `err` | `string` \| [`DetailedError`](../interfaces/mermaid.DetailedError.md) \| `unknown` |
|
|
| `hash?` | `any` |
|
|
|
|
##### Returns
|
|
|
|
`void`
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/Diagram.ts:9](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/Diagram.ts#L9)
|
|
|
|
## Variables
|
|
|
|
### default
|
|
|
|
• `Const` **default**: [`Mermaid`](../interfaces/mermaid.Mermaid.md)
|
|
|
|
#### Defined in
|
|
|
|
[packages/mermaid/src/mermaid.ts:430](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L430)
|