Libraries v5.0.0
    Preparing search index...

    Interface RelationInfo<TKind, TForeign>

    Phantom info for a single declared relation, stored on Entity's TRels generic. TForeign is captured so .include() can type the customize callback against the correct foreign schema.

    interface RelationInfo<
        TKind extends "belongsTo"
        | "hasOne"
        | "hasMany"
        | "belongsToMany" = any,
        TForeign extends
            ObjectSchemaBuilder<any, any, any, any, any, any, any> = ObjectSchemaBuilder<
            any,
            any,
            any,
            any,
            any,
            any,
            any,
        >,
    > {
        foreign: TForeign;
        kind: TKind;
    }

    Type Parameters

    • TKind extends "belongsTo" | "hasOne" | "hasMany" | "belongsToMany" = any
    • TForeign extends ObjectSchemaBuilder<any, any, any, any, any, any, any> = ObjectSchemaBuilder<any, any, any, any, any, any, any>
    Index
    foreign kind
    foreign: TForeign

    Foreign schema retained at the type level for relation callback completion.

    kind: TKind

    Relation cardinality used to infer nested object or collection results.

    Settings
    Member Visibility

    On This Page
    Properties