docs(router): add api docs
This commit is contained in:
@ -44,7 +44,7 @@ export interface NavigationExtras {
|
||||
/**
|
||||
* An event triggered when a navigation starts
|
||||
*
|
||||
* @experimental
|
||||
* @stable
|
||||
*/
|
||||
export class NavigationStart {
|
||||
constructor(public id: number, public url: string) {}
|
||||
@ -55,7 +55,7 @@ export class NavigationStart {
|
||||
/**
|
||||
* An event triggered when a navigation ends successfully
|
||||
*
|
||||
* @experimental
|
||||
* @stable
|
||||
*/
|
||||
export class NavigationEnd {
|
||||
constructor(public id: number, public url: string, public urlAfterRedirects: string) {}
|
||||
@ -68,7 +68,7 @@ export class NavigationEnd {
|
||||
/**
|
||||
* An event triggered when a navigation is canceled
|
||||
*
|
||||
* @experimental
|
||||
* @stable
|
||||
*/
|
||||
export class NavigationCancel {
|
||||
constructor(public id: number, public url: string) {}
|
||||
@ -79,7 +79,7 @@ export class NavigationCancel {
|
||||
/**
|
||||
* An event triggered when a navigation fails due to unexpected error
|
||||
*
|
||||
* @experimental
|
||||
* @stable
|
||||
*/
|
||||
export class NavigationError {
|
||||
constructor(public id: number, public url: string, public error: any) {}
|
||||
@ -92,7 +92,7 @@ export class NavigationError {
|
||||
/**
|
||||
* An event triggered when routes are recognized
|
||||
*
|
||||
* @experimental
|
||||
* @stable
|
||||
*/
|
||||
export class RoutesRecognized {
|
||||
constructor(
|
||||
@ -105,14 +105,16 @@ export class RoutesRecognized {
|
||||
}
|
||||
|
||||
/**
|
||||
* @experimental
|
||||
* @stable
|
||||
*/
|
||||
export type Event = NavigationStart | NavigationEnd | NavigationCancel | NavigationError;
|
||||
|
||||
/**
|
||||
* The `Router` is responsible for mapping URLs to components.
|
||||
*
|
||||
* @experimental
|
||||
* See {@link RouterConfig) for more details and examples.
|
||||
*
|
||||
* @stable
|
||||
*/
|
||||
export class Router {
|
||||
private currentUrlTree: UrlTree;
|
||||
|
Reference in New Issue
Block a user