Property

@aurorajs.dev/catalyst-cli

---

@aurorajs.dev/catalyst-cli / generator/domain/model / Property

Interface: Property

Defined in: generator/domain/model.ts:198

Definition of a single property inside an aggregate. Maps to a SQL column, a DTO field, a GraphQL field, and optionally a form control.

Properties

aggregateName?

optional aggregateName?: string

Defined in: generator/domain/model.ts:200

Owning aggregate name. Set by the loader; optional at author time.

---

applyTimezone?

optional applyTimezone?: boolean

Defined in: generator/domain/model.ts:202

For dateTime (and timestamp): store with timezone when true.

---

arrayOptions?

optional arrayOptions?: PropertyArrayOptions

Defined in: generator/domain/model.ts:204

Element descriptor for array types.

---

autoIncrement?

optional autoIncrement?: boolean

Defined in: generator/domain/model.ts:206

SQL AUTO_INCREMENT for numeric primary keys.

---

decimals?

optional decimals?: number[]

Defined in: generator/domain/model.ts:208

Two-element tuple [precision, scale] for decimal types.

---

defaultValue?

optional defaultValue?: string | number

Defined in: generator/domain/model.ts:210

Literal default value emitted in the DTO / column definition.

---

enumOptions?

optional enumOptions?: string[]

Defined in: generator/domain/model.ts:212

Values accepted by a scalar enum property.

---

example?

optional example?: unknown

Defined in: generator/domain/model.ts:214

Concrete example surfaced in Swagger / GraphQL docs.

---

faker?

optional faker?: string

Defined in: generator/domain/model.ts:219

Faker locale method name used by the mocker (e.g. name.firstName). Overrides the default seed picked from PropertyType.

---

index?

optional index?: PropertyIndex

Defined in: generator/domain/model.ts:220

---

indexFields?

optional indexFields?: string[]

Defined in: generator/domain/model.ts:222

Composite index columns when this property owns a multi-column index.

---

indexName?

optional indexName?: string

Defined in: generator/domain/model.ts:223

---

indexUsing?

optional indexUsing?: PropertyIndexUsing

Defined in: generator/domain/model.ts:224

---

isI18n?

optional isI18n?: boolean

Defined in: generator/domain/model.ts:226

When true, the property participates in i18n table/relation generation.

---

length?

optional length?: number

Defined in: generator/domain/model.ts:227

---

maxLength?

optional maxLength?: number

Defined in: generator/domain/model.ts:228

---

minLength?

optional minLength?: number

Defined in: generator/domain/model.ts:229

---

modulePath?

optional modulePath?: string

Defined in: generator/domain/model.ts:231

Module path for relationship properties. Set by the loader.

---

name

name: string

Defined in: generator/domain/model.ts:233

Field name in camelCase (source of truth for every transformation).

---

nullable?

optional nullable?: boolean

Defined in: generator/domain/model.ts:234

---

primaryKey?

optional primaryKey?: boolean

Defined in: generator/domain/model.ts:235

---

readonly?

optional readonly?: boolean

Defined in: generator/domain/model.ts:236

---

relationship?

optional relationship?: PropertyRelationship

Defined in: generator/domain/model.ts:238

Relationship metadata when type is relationship.

---

type

type: PropertyType

Defined in: generator/domain/model.ts:239

---

unsigned?

optional unsigned?: boolean

Defined in: generator/domain/model.ts:241

Integer-only: unsigned column when true.

---

widget?

optional widget?: PropertyWidget

Defined in: generator/domain/model.ts:243

Frontend widget metadata, when the property is rendered in a form.