prorm API Reference
    Preparing search index...

    Interface TraverseOptions

    Options for traverse().

    interface TraverseOptions {
        direction?: TraverseDirection;
        minDepth?: number;
        maxDepth?: number;
        filter?: string;
        limit?: number;
    }
    Index
    direction? minDepth? maxDepth? filter? limit?
    direction?: TraverseDirection

    Traversal direction relative to the start vertex. Default 'OUTBOUND'.

    minDepth?: number

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

    maxDepth?: number

    Maximum traversal depth. Default 1.

    filter?: string

    Raw AQL boolean expression appended as a FILTER clause, evaluated per visited path with v (vertex), e (edge), and p (path) bound as in a normal AQL graph traversal (e.g. 'v.active == true'). Interpolated directly into the query - do not build this from unsanitized user input.

    limit?: number

    Cap the number of visited paths returned.

    Settings
    Member Visibility

    On This Page
    Properties