Class Router

Router class

See

router

Hierarchy

Observable
- Router

Index

Constructors

Properties

debug defaultRoute? loadedPath params routes suspendEvent

Methods

add fire getParams getPath goto handleRoute on onFirstListenerAdded relayEvent reload setPath start un

Constructors

constructor

new Router(): Router
Returns Router
Inherited from Observable.constructor
- Defined in Router.ts:48

Properties

`Private` debug

debug: boolean = false

`Private` `Optional` defaultRoute

defaultRoute?: Function

`Private` loadedPath

loadedPath: string = ""

`Private` params

params: string[] = []

`Private` routes

routes: Route[] = []

`Private` suspendEvent

suspendEvent: boolean = false

Methods

add

add(re, handler?): Router
Add a route

The first matching route will be executed
Parameters
- re: RegExp | RouterMethod
  
  eg. /^notes/(.*)$/
- Optional handler: RouterMethod
  
  Is called with the arguments matched in the route regexp. May return Promise so the router start() promise will resolve when this promise is resolved.
Returns Router
Example
```
go.Router.add(/^([a-zA-Z0-9]*)/([\d]*)$/, (entity:string, id:string) => {

});
```
- Defined in Router.ts:101

fire

fire<K>(eventName, ...args): boolean
Fire an event

When a listener returns false this function will return false too.
Type Parameters
- K extends "change"
Parameters
- eventName: K
- Rest ...args: Parameters<RouterEventMap<any>[K]>
Returns boolean
Overrides Observable.fire
- Defined in Router.ts:24

getParams

getParams(): string[]
Get the parameters evaluated from the router path

Returns string[]
- Defined in Router.ts:66

getPath

getPath(): string
Get the router path

Returns string
- Defined in Router.ts:59

goto

goto(path): Promise<unknown>
Go to the give router path
Parameters
- path: string
Returns Promise<unknown>
Promise
- Defined in Router.ts:187

`Private` handleRoute

handleRoute(handler, match, oldPath): Promise<any>
Parameters
- handler: Function
- match: string[]
- oldPath: string
Returns Promise<any>
- Defined in Router.ts:156

on

on<K, L>(eventName, listener, options?): L
Add a listener
Type Parameters
- K extends "change"
- L extends Listener
Parameters
- eventName: K
- listener: RouterEventMap<Router>[K]
- Optional options: ObservableListenerOpts
Returns L
Overrides Observable.on
- Defined in Router.ts:22

`Protected` onFirstListenerAdded

onFirstListenerAdded(eventName): void
Protected
Override this function to lazily initialize events
Parameters
- eventName: string
Returns void
Inherited from Observable.onFirstListenerAdded
- Defined in component/Observable.ts:133

`Protected` relayEvent

relayEvent(comp, type): void
Parameters
- comp: Observable
- type: any
Returns void
Inherited from Observable.relayEvent
- Defined in component/Observable.ts:199

reload

reload(): void
Reload current page.

Returns void
- Defined in Router.ts:177

setPath

setPath(path): void
Set route path without executing matching routes.
Parameters
- path: string
Returns void
- Defined in Router.ts:75

start

start(): Promise<void>
Start the router and run the matching route handlers

Returns Promise<void>
- Defined in Router.ts:123

un

un<K>(eventName, listener): boolean
Remove listener
Type Parameters
- K extends "change"
Parameters
- eventName: K
- listener: RouterEventMap<Router>[K]
Returns boolean
Overrides Observable.un
- Defined in Router.ts:23

Generated using TypeDoc