honeymoose
/
angular-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs(router): add docs

This commit is contained in:
vsavkin 2016-06-03 14:28:41 -07:00
parent 88920bfee1
commit 6ce7a5a1ea
1 changed files with 29 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
modules/@angular/router/src/router.ts
View File

@ -26,10 +26,26 @@ import {forkJoin} from 'rxjs/observable/forkJoin';
export interface NavigationExtras { relativeTo?: ActivatedRoute; queryParameters?: Params; fragment?: string; } export interface NavigationExtras { relativeTo?: ActivatedRoute; queryParameters?: Params; fragment?: string; }
/**
* An event triggered when a navigation starts
*/
export class NavigationStart { constructor(public id:number, public url:UrlTree) {} } export class NavigationStart { constructor(public id:number, public url:UrlTree) {} }
/**
* An event triggered when a navigation ends successfully
*/
export class NavigationEnd { constructor(public id:number, public url:UrlTree) {} } export class NavigationEnd { constructor(public id:number, public url:UrlTree) {} }
/**
* An event triggered when a navigation is canceled
*/
export class NavigationCancel { constructor(public id:number, public url:UrlTree) {} } export class NavigationCancel { constructor(public id:number, public url:UrlTree) {} }
/**
* An event triggered when a navigation fails due to unexpected error
*/
export class NavigationError { constructor(public id:number, public url:UrlTree, public error:any) {} } export class NavigationError { constructor(public id:number, public url:UrlTree, public error:any) {} }
export type Event = NavigationStart | NavigationEnd | NavigationCancel | NavigationError; export type Event = NavigationStart | NavigationEnd | NavigationCancel | NavigationError;
/** /**
@ -68,6 +84,9 @@ export class Router {
return this.currentUrlTree; return this.currentUrlTree;
} }
/**
* Returns an observable of route events
*/
get events(): Observable<Event> { get events(): Observable<Event> {
return this.routerEvents; return this.routerEvents;
} }
@ -75,6 +94,11 @@ export class Router {
/** /**
* Navigate based on the provided url. This navigation is always absolute. * Navigate based on the provided url. This navigation is always absolute.
* *
* Returns a promise that:
* - is resolved with 'true' when navigation succeeds
* - is resolved with 'false' when navigation fails
* - is rejected when an error happens
*
* ### Usage * ### Usage
* *
* ``` * ```
@ -150,6 +174,11 @@ export class Router {
* Navigate based on the provided array of commands and a starting point. * Navigate based on the provided array of commands and a starting point.
* If no starting route is provided, the navigation is absolute. * If no starting route is provided, the navigation is absolute.
* *
* Returns a promise that:
* - is resolved with 'true' when navigation succeeds
* - is resolved with 'false' when navigation fails
* - is rejected when an error happens
*
* ### Usage * ### Usage
* *
* ``` * ```