Class MermaidGenerator

Index

Constructors

Methods

generate Generate generateHtml GenerateHtml

Constructors

constructor

new MermaidGenerator(): MermaidGenerator
Returns MermaidGenerator

Methods

generate

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

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:20

generateHtml

generateHtml(
state: DatabaseDocumentation,
options?: MermaidGeneratorOptions,
): string
Parameters
- state: DatabaseDocumentation
- options: MermaidGeneratorOptions = {}
Returns string
Deprecated
Use GenerateHtml.
- Defined in packages/DBAutoDoc/src/generators/MermaidGenerator.ts:370

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:209