Class Router

Hierarchy

Router

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Router(routes: Route[], opts?: RouterOptions): Router

- Defined in Router.ts:27
Parameters
- routes: Route[]
- opts: RouterOptions = {}
Returns Router

Properties

Private appRoutes

appRoutes: Route[] = []

Private baseTitle

baseTitle: string = ''

Private baseUrl

baseUrl: string = '/'

Private listeners

listeners: ((update: RouteUpdate) => void)[] = []

Accessors

base

get base(): string

- Defined in Router.ts:35
Returns string

currentRoute

get currentRoute(): Route

- Defined in Router.ts:39
Returns Route

Methods

guardPath

guardPath(path: string, stripQuery?: boolean): string

- Defined in Router.ts:78
Parameters
- path: string
- stripQuery: boolean = true
Returns string

Private listenToPopState

listenToPopState(): void

- Defined in Router.ts:107
Returns void

Private publishChange

publishChange(toRoute: Route, fromRoute?: Route): void

- Defined in Router.ts:126
Parameters
- toRoute: Route
- Optional fromRoute: Route
Returns void

push

push(location: string): void

- Defined in Router.ts:55
Parameters
- location: string
Returns void

setPageTitle

setPageTitle(title?: string): void

- Defined in Router.ts:90
Parameters
- Optional title: string
Returns void

subscribe

subscribe(fn: (update: RouteUpdate) => void): () => void

- Defined in Router.ts:47
Parameters
- fn: (update: RouteUpdate) => void
  - - (update: RouteUpdate): void
    - Parameters
      - update: RouteUpdate
      Returns void
Returns () => void
- - (): void
  - Returns void

Generated using TypeDoc