Aberdeen - v1.1.0
    Preparing search index...

    Interface Route

    The class for the global route object.

    interface Route {
        depth: number;
        hash: string;
        nav: NavType;
        p: string[];
        path: string;
        search: Record<string, string>;
        state: Record<string, any>;
    }
    Index

    Properties

    depth: number

    The navigation depth of the current session. Starts at 1. Writing to this property has no effect.

    hash: string

    The hash fragment including the leading #, or an empty string. For instance "#my_section" or "".

    nav: NavType

    The navigation action that got us to this page. Writing to this property has no effect.

    • "load": An initial page load.
    • "back" or "forward": When we navigated backwards or forwards in the stack.
    • "go": When we added a new page on top of the stack. Mostly useful for page transition animations. Writing to this property has no effect.
    p: string[]

    An convenience array containing path segments, mapping to path. For instance [] (for "/") or ['users', '123', 'feed'] (for "/users/123/feed").

    path: string

    The current path of the URL as a string. For instance "/" or "/users/123/feed". Paths are normalized to always start with a / and never end with a / (unless it's the root path).

    search: Record<string, string>

    The query string interpreted as search parameters. So "a=x&b=y" becomes {a: "x", b: "y"}.

    state: Record<string, any>

    An object to be used for any additional data you want to associate with the current page. Data should be JSON-compatible.