Interface EntityReferenceFieldDescription<EntityTypeIDs>

A reference field.

interface EntityReferenceFieldDescription<EntityTypeIDs extends number> {
    derived: boolean;
    kind: STEP_REFERENCE;
    offset?: number;
    optional: boolean;
    rank?: number;
    type: EntityTypeIDs;
}

Type Parameters

  • EntityTypeIDs extends number

Hierarchy (View Summary)

Properties

derived: boolean

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

The kind of this field.

offset?: number

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

optional: boolean

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

rank?: number

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

The type reference for this field as an ID, which can be used to look-up a schema.