Interface IRouter

A static class that routes URLs within the application.

interface IRouter {
    base: string;
    commands: CommandRegistry;
    current: ILocation;
    routed: ISignal<IRouter, ILocation>;
    stop: Token<void>;
    navigate(path: string, options?: INavOptions): void;
    register(options: IRegisterOptions): IDisposable;
    reload(): void;
    route(url: string): void;
}

Implemented by

Router

Index

Properties

base commands current routed stop

Methods

navigate register reload route

Properties

`Readonly`base

base: string

The base URL for the router.

`Readonly`commands

commands: CommandRegistry

The command registry used by the router.

`Readonly`current

current: ILocation

The parsed current URL of the application.

`Readonly`routed

routed: ISignal<IRouter, ILocation>

A signal emitted when the router routes a route.

`Readonly`stop

stop: Token<void>

If a matching rule's command resolves with the stop token during routing, no further matches will execute.

Methods

navigate

navigate(path: string, options?: INavOptions): void
Navigate to a new path within the application.
Parameters
- path: string
  The new path or empty string if redirecting to root.
- Optionaloptions: INavOptions
  The navigation options.
Returns void
- Defined in packages/application/src/tokens.ts:131

register

register(options: IRegisterOptions): IDisposable
Register a rule that maps 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.
- Defined in packages/application/src/tokens.ts:140

reload

reload(): void
Cause a hard reload of the document.

Returns void
- Defined in packages/application/src/tokens.ts:145

route

route(url: string): void
Route a specific path to an action.
Parameters
- url: string
  The URL string that will be routed.
  
  Notes
  If a pattern is matched, its command will be invoked with arguments that match the IRouter.ILocation interface.
Returns void
- Defined in packages/application/src/tokens.ts:156