prorm API Reference
    Preparing search index...

    Interface GraphAssociationSpec

    How an ORM association becomes a graph edge. hasMany/hasOne become an OUTBOUND edge from the source node; belongsTo becomes an INBOUND edge (the inverse); belongsToMany becomes an OUTBOUND edge over the join relationship. The edge label defaults to a derived name but can be set explicitly.

    interface GraphAssociationSpec {
        type: GraphAssociationType;
        as: string;
        target: string;
        edgeLabel: string;
        direction: "in" | "out";
    }
    Index
    type as target edgeLabel direction
    type: GraphAssociationType
    as: string

    Association name as used in include, e.g. posts.

    target: string

    Target node label, e.g. Post.

    edgeLabel: string

    Relationship/edge type/label, e.g. HAS_POST.

    direction: "in" | "out"

    Edge direction from the source node's perspective.

    Settings
    Member Visibility

    On This Page
    Properties