Member Junction
    Preparing search index...

    Interface WalkOptions

    Options controlling graph traversal.

    interface WalkOptions {
        EdgePolicy?: (edge: GraphEdgeCandidate) => EdgePolicyDecision;
        EntityFilter?: string[];
        ExcludeEntities?: string[];
        FollowHierarchies?: boolean;
        IncludeDeleted?: boolean;
        IncludeSoftLinks?: boolean;
        IncludeSubtypes?: boolean;
        ListNonCuratedInbound?: boolean;
        MaxDepth?: number;
        OnLoadFailure?: (failure: GraphLoadFailure) => void;
        RequireTrackRecordChanges?: boolean;
    }
    Index

    Properties

    EdgePolicy? EntityFilter? ExcludeEntities? FollowHierarchies? IncludeDeleted? IncludeSoftLinks? IncludeSubtypes? ListNonCuratedInbound? MaxDepth? OnLoadFailure? RequireTrackRecordChanges?

    Properties

    EdgePolicy?: (edge: GraphEdgeCandidate) => EdgePolicyDecision

    Called per candidate edge before traversal; returning Skip prunes the walk, Reference records the target without recursing, Deep recurses.

    EntityFilter?: string[]

    Only include these entities

    ExcludeEntities?: string[]

    Skip these entities

    FollowHierarchies?: boolean

    Allow same-entity recursion on fields whose Configuration.Hierarchy.IsHierarchy is true, up to HierarchyMaxDepth. Default false.

    IncludeDeleted?: boolean

    Include soft-deleted records (default: false)

    IncludeSoftLinks?: boolean

    Follow inbound EntityID/RecordID soft links as reverse edges. Default false.

    IncludeSubtypes?: boolean

    Add IS-A subtype rows of every discovered record as nodes (via FindISAChildEntities). Default false.

    ListNonCuratedInbound?: boolean

    List (without loading) inbound FK relationships that are not curated EntityRelationship rows, so a caller can show "available" edges. Default false.

    MaxDepth?: number

    Maximum recursion depth (default: 10 for Version History, 3 for cloning)

    OnLoadFailure?: (failure: GraphLoadFailure) => void

    Called when the rows of an edge the walk follows can't be loaded (no read permission, a failed query). The walk goes on without them, so a caller that must not act on a partial graph (cloning) reports it. Default: the failure is only logged.

    RequireTrackRecordChanges?: boolean

    Whether to require entities to have TrackRecordChanges enabled. Version History passes true (or defaults to true); cloning passes false. Default: true

    Settings

    Member Visibility

    On This Page

    Properties