Class Router

Controls what happens when certain url paths match a set of criteria

Hierarchy

Service
- Router

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Router(routes?: IRoute[]): Router

Overrides Service.constructor
- Defined in packages/native/src/router.ts:25
Parameters
- routes: IRoute[] = []
Returns Router

Properties

app

app: IApp

The App the ManagerItem is attached to

config

config: ICONFIG

The Config of the App the ManagerItem is attached to

emitter

emitter: EventEmitter

The EventEmitter of the App the ManagerItem is attached to

key

key: any

The key to where ManagerItem is stored in an AdvancedManager

manager

manager: TypeAdvancedManager

The AdvancedManager the ManagerItem is attached to

Protected routes

routes: Manager<IRouteToFrom, TypeRouteMethod>

List of routes

Methods

add

add(__namedParameters: IRoute): Router

- Defined in packages/native/src/router.ts:34
Add a new route to watch for

Parameters
- __namedParameters: IRoute
Returns Router

boot

boot(...args: any): any

Inherited from Service.boot
- Defined in packages/native/src/service.ts:11
Called on start of Service

Parameters
- Rest ...args: any
Returns any

init

init(...args: any): any

Inherited from Service.init
- Defined in packages/native/src/service.ts:7
Called before the start of a Service, represents a constructor of sorts

Parameters
- Rest ...args: any
Returns any

initEvents

initEvents(): void

Overrides Service.initEvents
- Defined in packages/native/src/router.ts:135
Add listeners for PJAX Events

Returns void

install

install(): any

Inherited from Service.install
- Defined in packages/native/src/manager.ts:29
Run after the Manager Item has been registered

Returns any

isPath

isPath(input: TypeRouteStyle): boolean

- Defined in packages/native/src/router.ts:55
Determines if a strings counts has a path

Parameters
- input: TypeRouteStyle
Returns boolean

parse

parse(input: TypeRoutePath): IRouteToFrom

- Defined in packages/native/src/router.ts:65
Parse the multiple different formats for paths, into a { from, to } object

Parameters
- input: TypeRoutePath
Returns IRouteToFrom

parsePath

parsePath(path: TypeRouteStyle): boolean | RegExp

- Defined in packages/native/src/router.ts:41
Convert strings into path match functions

Parameters
- path: TypeRouteStyle
Returns boolean | RegExp

register

register(manager: TypeAdvancedManager, key: any): ManagerItem

Inherited from Service.register
- Defined in packages/native/src/manager.ts:32
Register the current Manager Item's manager

Parameters
- manager: TypeAdvancedManager
- key: any
Returns ManagerItem

route

route(): void

- Defined in packages/native/src/router.ts:90
Test if route paths are true, if so run their methods

Returns void

stop

stop(): void

Inherited from Service.stop
- Defined in packages/native/src/service.ts:23
Stop Service

Returns void

stopEvents

stopEvents(): void

Overrides Service.stopEvents
- Defined in packages/native/src/router.ts:141
Remove listeners for PJAX Events

Returns void

uninstall

uninstall(): any

Inherited from Service.uninstall
- Defined in packages/native/src/manager.ts:43
Run before the ManagerItem has been unregistered

Returns any

unregister

unregister(): void

Inherited from Service.unregister
- Defined in packages/native/src/manager.ts:46
Basically removes a ManagerItem, in order to recover the ManagerItem, it needs to be re-added to an AdvancedManager

Returns void

Generated using TypeDoc