Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Implements

  • INotify

Index

Constructors

constructor

Properties

config

config: RouterConfig

current

current: RouteMatch | undefined

Protected currentPath

currentPath: string

Protected hashHandler

hashHandler: Fn<HashChangeEvent, void>

Protected ignoreHashChange

ignoreHashChange: boolean

Protected popHandler

popHandler: Fn<PopStateEvent, void>

Protected useFragment

useFragment: boolean

Methods

addListener

  • addListener(id: string, fn: Listener, scope?: any): boolean

format

  • format(id: PropertyKey, params?: any): string
  • format(match: Partial<RouteMatch>): string

Protected handleHashChange

  • handleHashChange(): Fn<HashChangeEvent, void>

Protected handlePopChange

  • handlePopChange(): Fn<PopStateEvent, void>

Protected handleRouteFailure

  • handleRouteFailure(): boolean

Protected matchRoute

Protected matchRoutes

notify

  • notify(event: Event): void

release

  • release(): void

removeListener

  • removeListener(id: string, fn: Listener, scope?: any): boolean

route

  • route(src: string, pushState?: boolean): undefined | RouteMatch
  • Like BasicRouter.route(), but takes additional arg to control if this routing operation should manipulate the browser's history. If called from userland, this normally is true. However, we want to avoid this if called from this router's own event handlers.

    Parameters

    • src: string
    • Default value pushState: boolean = true

      -

    Returns undefined | RouteMatch

routeForID

  • routeForID(id: string): undefined | Route

routeTo

  • routeTo(route: string): void

start

  • start(): void

Protected validateRouteParams

Generated using TypeDoc