UNPKG

typeorm-erd

Version:

Create ERD from TypeORM with outputs as Mermaid, or PlantUML

20 lines (19 loc) 715 B
import { DataSource, EntityMetadata } from "typeorm"; import { BuilderRelations } from "../builder"; /** * Render a mermaid ERD based on the spec here: * https://mermaid-js.github.io/mermaid/#/entityRelationshipDiagram */ export declare class MermaidErd { readonly dataSource: DataSource; private entityBuilder; private relationBuilder; private meta; private relations; constructor(dataSource: DataSource, entityBuilder?: (connection: DataSource) => Promise<EntityMetadata[]>, relationBuilder?: (meta: EntityMetadata[]) => BuilderRelations); initialize(): Promise<void>; render(): string; renderRelations(): string; buildRelations(): string[]; private renderTables; }