Class BasicRouter

Hierarchy

BasicRouter
- HTMLRouter

Implements

INotify

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new BasicRouter(config: RouterConfig): BasicRouter

- Defined in router/src/basic.ts:23
Parameters
- config: RouterConfig
Returns BasicRouter

Properties

config

config: RouterConfig

current

current: undefined | RouteMatch

Methods

addListener

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

- Defined in router/src/basic.ts:55
{@inheritDoc @thi.ng/api#INotify.addListener}
Parameters
- id: string
- fn: Listener
- Optional scope: any
Returns boolean

format

format(id: string, params?: any, hash?: boolean): string
format(match: Partial<RouteMatch>, hash?: boolean): string

- Defined in router/src/basic.ts:109
Returns a formatted version of given RouteMatch, incl. any params. Throw an error if an invalid route id is provided.
Parameters
- id: string
- Optional params: any
  -
- Optional hash: boolean
  if true, prepends # to results
Returns string
- Defined in router/src/basic.ts:110
Parameters
- match: Partial<RouteMatch>
- Optional hash: boolean
Returns string

Protected handleRouteFailure

handleRouteFailure(): boolean

- Defined in router/src/basic.ts:211
Returns boolean

Protected matchRoute

matchRoute(curr: string[], route: Route): undefined | RouteMatch

- Defined in router/src/basic.ts:168
Parameters
- curr: string[]
- route: Route
Returns undefined | RouteMatch

Protected matchRoutes

matchRoutes(src: string): undefined | RouteMatch

- Defined in router/src/basic.ts:157
Parameters
- src: string
Returns undefined | RouteMatch

notify

notify(event: Event): void

- Defined in router/src/basic.ts:63
{@inheritDoc @thi.ng/api#INotify.notify}
Parameters
- event: Event
Returns void

removeListener

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

- Defined in router/src/basic.ts:59
{@inheritDoc @thi.ng/api#INotify.removeListener}
Parameters
- id: string
- fn: Listener
- Optional scope: any
Returns boolean

route

route(src: string): undefined | RouteMatch

- Defined in router/src/basic.ts:81
Main router function. Attempts to match given input string against all configured routes. If none matches, falls back to default route. Before returning, triggers event with return value as well.
Parameters
- src: string
Returns undefined | RouteMatch

routeForID

routeForID(id: string): undefined | Route

- Defined in router/src/basic.ts:153
Parameters
- id: string
Returns undefined | Route

start

start(): void

- Defined in router/src/basic.ts:65
Returns void

Protected validateRouteParams

validateRouteParams(params: any, validators: IObjectOf<Partial<RouteParamValidator>>): boolean

- Defined in router/src/basic.ts:193
Parameters
- params: any
- validators: IObjectOf<Partial<RouteParamValidator>>
Returns boolean

Generated using TypeDoc