Interface MermaidLike

The slice of the Mermaid API this package touches. Structural, so the real mermaid module, a lazily loaded copy, or a test double all fit, and the package itself never has to depend on Mermaid.

interface MermaidLike {
initialize?(config: Record<string, unknown>): void;
render(id: string, code: string): Promise<{ svg: string }>;
}

Index

Methods

initialize? render

Methods

`Optional`initialize

initialize?(config: Record<string, unknown>): void
Parameters
- config: Record<string, unknown>
Returns void
- Defined in mermaid.ts:9

render

render(id: string, code: string): Promise<{ svg: string }>
Parameters
- id: string
- code: string
Returns Promise<{ svg: string }>
- Defined in mermaid.ts:10