Interface EntitySelectFieldDescription<EntityTypeIDs>

A field representing a select type (has multiple options)

interface EntitySelectFieldDescription<EntityTypeIDs extends number> {
    derived: boolean;
    kind: SELECT;
    offset?: number;
    optional: boolean;
    options: (
        (
            | EntityReferenceFieldDescription<EntityTypeIDs>
            | EntityEnumFieldDescription<EntityTypeIDs>
        ) & EntityFieldDescriptionRequired<EntityTypeIDs>
    )[];
    rank?: number;
}

Type Parameters

  • EntityTypeIDs extends number

Hierarchy (View Summary)

Properties

derived kind offset? optional options rank?

Properties

derived

derived: boolean

Is this field derived? i.e. generated from a function.

kind

kind: SELECT

The kind of this field.

Optionaloffset

offset?: number

For non derived fields, this is the ordinal position of the field within a positional serialization.

optional

optional: boolean

Is this field optional? Note, logical fields will be treated as boolean optionals.

options

options: (
    (
        | EntityReferenceFieldDescription<EntityTypeIDs>
        | EntityEnumFieldDescription<EntityTypeIDs>
    ) & EntityFieldDescriptionRequired<EntityTypeIDs>
)[]

The various options that can be selected from.

Optionalrank

rank?: number

Defined if this is an array, with the rank (how many nested arrays/dimensions are there)

Settings

Member Visibility

On This Page

Properties