Class ErdClusterGenerator

Index

Constructors

Methods

Generate RenderPage

Constructors

constructor

new ErdClusterGenerator(): ErdClusterGenerator
Returns ErdClusterGenerator

Methods

Generate

Generate(
    state: DatabaseDocumentation,
    plan: ErdClusterPlan,
    options?: ErdClusterGeneratorOptions,
): ErdClusterOutput
Parameters
- state: DatabaseDocumentation
- plan: ErdClusterPlan
- options: ErdClusterGeneratorOptions = {}
Returns ErdClusterOutput
- Defined in packages/DBAutoDoc/src/generators/ErdClusterGenerator.ts:41

RenderPage

RenderPage(
    plan: ErdClusterPlan,
    cluster: ErdCluster,
    page: ErdClusterPage,
    columns?: ErdColumnMode,
): string
The Mermaid source for one page: its tables and the FK edges between them.
Parameters
- plan: ErdClusterPlan
- cluster: ErdCluster
- page: ErdClusterPage
- columns: ErdColumnMode = 'keys'
Returns string
- Defined in packages/DBAutoDoc/src/generators/ErdClusterGenerator.ts:66