Interface RouterOptions<T>

Type Parameters

  • T extends Record<string, Route> = Record<string, Route>

Hierarchy

  • RouterOptions

Properties

beforeRemove? fallbackRoute? initialRoute noRouteBuilder? remove? rootParent routes start? window?

Properties

Optional beforeRemove

beforeRemove?: ((route) => boolean | Promise<boolean>)

Type declaration

    • (route): boolean | Promise<boolean>

    • Parameters

      Returns boolean | Promise<boolean>

Optional fallbackRoute

fallbackRoute?: string

initialRoute

initialRoute: string

Optional noRouteBuilder

noRouteBuilder?: RouteBuilder

Optional remove

remove?: ((route) => boolean | Promise<boolean>)

Type declaration

    • (route): boolean | Promise<boolean>

    • Parameters

      Returns boolean | Promise<boolean>

rootParent

rootParent: CTag

routes

routes: T

Optional start

start?: ((route) => boolean | Promise<boolean>)

Type declaration

    • (route): boolean | Promise<boolean>

    • Parameters

      Returns boolean | Promise<boolean>

Optional window

window?: Window & typeof globalThis

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc