Stone.js API
    Preparing search index...

    Interface RouterLike

    The shape this module needs from a router.

    interface RouterLike {
        generate?: (options: { name: string; [key: string]: unknown }) => string;
        getRoutes: () => { getRoutes: () => RouteLike[] };
    }
    Index
    generate? getRoutes
    generate?: (options: { name: string; [key: string]: unknown }) => string

    The URL of a named route, prefix included.

    Optional, because this package duck-types a router rather than depending on it. It is how the explorer finds the document: a route's declared path is not where it is served once the router carries a prefix.

    getRoutes: () => { getRoutes: () => RouteLike[] }

    Settings
    Member Visibility

    On This Page
    Properties