Class Router

constructor

• new Router(options): Router

• Create a URL router.

  Parameters

  • options: Router.IOptions

  Returns Router

Readonly base

Readonly commands

Readonly stop

current

• get current(): ILocation

• Returns the parsed current URL of the application.

  Returns ILocation

routed

• get routed(): ISignal<this, ILocation>

• A signal emitted when the router routes a route.

  Returns ISignal<this, ILocation>

navigate

• navigate(path, options?): void

• Navigate to a new path within the application.

  Parameters

  • path: string

    The new path or empty string if redirecting to root.
  • options: INavOptions = {}

    The navigation options.

  Returns void

register

• register(options): IDisposable

• Register to route a path pattern to a command.

  Parameters

  • options: IRegisterOptions

    The route registration options.

  Returns IDisposable

  A disposable that removes the registered rule from the router.

reload

• reload(): void

• Cause a hard reload of the document.

  Returns void

route

• route(): Promise<void>

• Route a specific path to an action.

  Notes

  If a pattern is matched, its command will be invoked with arguments that match the IRouter.ILocation interface.

  Returns Promise<void>