Type alias Router<T>

Router<T>: {
    initialRoute: Route<T>;
    start: Start<T>;
    syncLocationBar: SyncLocationBar<T>;
    toRoute: ToRoute<T>;
    toUrl: ToUrl<T>;
}

Router created by createRouter.

Type Parameters

  • T extends string = string

    See RouteConfig for details.

Type declaration

  • initialRoute: Route<T>

    The initial route as parsed from the location bar.

  • start: Start<T>

    Function to start the router.

  • syncLocationBar: SyncLocationBar<T>

    Function that synchronizes the location bar with the application state route.

  • toRoute: ToRoute<T>

    Function to generate a Route.

  • toUrl: ToUrl<T>

    Function to generate a URL.

Generated using TypeDoc