Interface BuildERDDataOptions

Options for building ERD data from entities.

interface BuildERDDataOptions {
    allEntities?: EntityInfo[];
    depth?: number;
    includeIncoming?: boolean;
    includeOutgoing?: boolean;
}

Properties

allEntities?: EntityInfo[]

All entities in the system (for relationship lookups). Required for includeIncoming/includeOutgoing.

depth?: number

Relationship depth - how many hops to include. Default: 1

includeIncoming?: boolean

Include incoming relationships (entities that reference these entities). Default: true

includeOutgoing?: boolean

Include outgoing relationships (entities these reference via FK). Default: true