Interface ModelDiagramOptions

interface ModelDiagramOptions {
    name: string;
    tableName?: string;
    fields: Record<string, FieldDefinition>;
    associations?: AssociationDefinition[];
    timestamps?: boolean;
    paranoid?: boolean;
    underscored?: boolean;
    comment?: string;
    theme?: "light" | "dark";
    color?: string;
}

Index

Properties

name tableName? fields associations? timestamps? paranoid? underscored? comment? theme? color?

Properties

name

name: string

Model class name, e.g. "User"

`Optional`tableName

tableName?: string

Override database table name

fields

fields: Record<string, FieldDefinition>

Map of column-name to field definition

`Optional`associations

associations?: AssociationDefinition[]

`Optional`timestamps

timestamps?: boolean

`Optional`paranoid

paranoid?: boolean

`Optional`underscored

underscored?: boolean

`Optional`comment

comment?: string

`Optional`theme

theme?: "light" | "dark"

Accepted for backward compatibility and ignored: diagrams render in a single monochrome theme.

`Optional`color

color?: string

Accepted for backward compatibility and ignored.