g3-toolkit API Reference
    Preparing search index...

    Interface PathOptions

    interface PathOptions {
        directed?: boolean;
        edgeTypes?: string[];
        maxHops?: number;
        nodeFilter?: (id: string) => boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    directed? edgeTypes? maxHops? nodeFilter?

    Properties

    directed?: boolean

    Follow edges from source to target only (default: false, every edge is walkable from either endpoint).

    edgeTypes?: string[]

    Edge types to traverse (default: all).

    maxHops?: number

    Maximum hops to search (default: unlimited). A target farther than this comes back found: false; the search stops at the bound instead of running the graph to exhaustion.

    nodeFilter?: (id: string) => boolean

    Admit a node into a path (default: every node). The two endpoints are exempt: a search between two hub nodes still finds them, the filter only decides which nodes may sit BETWEEN them.

    Settings

    Member Visibility

    On This Page

    Properties