prorm API Reference
    Preparing search index...

    Interface GraphTraversalSpec

    Spec for a variable-length / multi-hop traversal from a start node.

    interface GraphTraversalSpec {
        label: string;
        where?: WhereOptions;
        edgeLabel?: string;
        direction?: GraphTraversalDirection;
        targetLabel?: string;
        minDepth?: number;
        maxDepth?: number;
        targetWhere?: WhereOptions;
        limit?: number;
    }
    Index
    label where? edgeLabel? direction? targetLabel? minDepth? maxDepth? targetWhere? limit?
    label: string

    Start node label.

    where?: WhereOptions

    Filter selecting the start node(s).

    edgeLabel?: string

    Single edge label (shorthand) or an explicit chain of steps.

    direction?: GraphTraversalDirection
    targetLabel?: string
    minDepth?: number

    Minimum traversal depth (1 = direct neighbours). Default 1.

    maxDepth?: number

    Maximum traversal depth. Default 1.

    targetWhere?: WhereOptions

    Filter applied to reached nodes.

    limit?: number

    Settings
    Member Visibility

    On This Page
    Properties