Interface EnumAttributeOptions

Extends AttributeOptions but requires that the allowed values are set on values

interface EnumAttributeOptions {
    alias?: string;
    nullable?: boolean;
    values: [string, ...string[]];
}

Hierarchy (view full)

Properties

alias? nullable? values

Properties

Optional alias

alias?: string

An optional alias for the attribute as represented in the database table.

This alias is used as the column name in the database table corresponding to the entity. If omitted, the ORM defaults to using the attribute's key as defined within the entity model. Specifying an alias allows for mapping between the entity's attribute names in the code and their respective column names in the database, providing flexibility in naming conventions and supporting scenarios where column names in the database differ from attribute names in the code.

Optional nullable

nullable?: boolean

Whether or not the attribute is nullable. Defaults to false

values

values: [string, ...string[]]

Settings

Member Visibility

Theme

On This Page

aliasnullablevalues

Generated using TypeDoc