Interface ObjectAttributeOptions<S>

Options for the @ObjectAttribute decorator. Extends AttributeOptions with a required schema field describing the object shape.

The schema supports all FieldDef types: primitives, enums, nested objects, and arrays.

Example

@ObjectAttribute({ alias: "Address", schema: addressSchema })
public readonly address: InferObjectSchema<typeof addressSchema>;

@ObjectAttribute({ alias: "Meta", schema: metaSchema, nullable: true })
public readonly meta?: InferObjectSchema<typeof metaSchema>;
interface ObjectAttributeOptions<S extends ObjectSchema> {
    alias?: string;
    nullable?: boolean;
    schema: S;
}

Type Parameters

  • S extends ObjectSchema

    The specific ObjectSchema type used for type inference

Hierarchy (View Summary)

Properties

alias? nullable? schema

Properties

Optionalalias

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.

Optionalnullable

nullable?: boolean

Whether or not the attribute is nullable. Defaults to false

schema

schema: S

The ObjectSchema defining the structure of the object attribute.

Must be declared with as const satisfies ObjectSchema for accurate type inference.

Settings

Member Visibility

On This Page

Properties