Class MermaidGenerator

Index

Constructors

Methods

generate generateHtml

Constructors

constructor

new MermaidGenerator(): MermaidGenerator
Returns MermaidGenerator

Methods

generate

generate(
state: DatabaseDocumentation,
options?: MermaidGeneratorOptions,
): string
Generate Mermaid ERD diagram
Parameters
- state: DatabaseDocumentation
- options: MermaidGeneratorOptions = {}
Returns string
- Defined in packages/DBAutoDoc/src/generators/MermaidGenerator.ts:17

generateHtml

generateHtml(
state: DatabaseDocumentation,
options?: MermaidGeneratorOptions,
): string
Generate an HTML-wrapped version of the Mermaid diagram Useful for standalone rendering
Parameters
- state: DatabaseDocumentation
- options: MermaidGeneratorOptions = {}
Returns string
- Defined in packages/DBAutoDoc/src/generators/MermaidGenerator.ts:196