Member Junction
    Preparing search index...

    Interface GraphEdgeCandidate

    Information about a candidate edge presented to an EdgePolicy callback before traversal.

    interface GraphEdgeCandidate {
        CollectionName?: string;
        Depth: number;
        EntityIDFieldName?: string;
        HierarchyDirection?: "Up" | "Down";
        IsSoftLink?: boolean;
        JoinField: string;
        Kind: EdgeKind;
        Relationship?: EntityRelationshipInfo;
        SourceEntityName: string;
        SourceKey: CompositeKey;
        SourceRecordData: Record<string, unknown>;
        TargetEntityName: string;
        TargetKey?: CompositeKey;
    }
    Index

    Properties

    CollectionName? Depth EntityIDFieldName? HierarchyDirection? IsSoftLink? JoinField Kind Relationship? SourceEntityName SourceKey SourceRecordData TargetEntityName TargetKey?

    Properties

    CollectionName?: string
    Depth: number
    EntityIDFieldName?: string
    HierarchyDirection?: "Up" | "Down"

    For Hierarchy edges: Down to a child row (its parent FK points at the source), Up to the source's own parent (the source's parent FK). A subtree walk goes down; up is the parent it hangs from.

    IsSoftLink?: boolean
    JoinField: string
    Kind: EdgeKind
    Relationship?: EntityRelationshipInfo
    SourceEntityName: string
    SourceKey: CompositeKey
    SourceRecordData: Record<string, unknown>
    TargetEntityName: string
    TargetKey?: CompositeKey

    Settings

    Member Visibility

    On This Page

    Properties