cargdev/angular
1
0
Fork 0
Code Issues 10 Pull Requests Actions Packages Projects Releases Wiki Activity

doc: add some API doc

Browse Source 
Closes #4060
This commit is contained in:
Victor Berchet
2015-09-03 16:17:23 -07:00
parent 5e013c4aef
commit 998c7c2e03
9 changed files with 164 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
modules/angular2/src/router/router.ts
View File

@ -27,17 +27,17 @@ let _resolveToTrue = PromiseWrapper.resolve(true);
let _resolveToFalse = PromiseWrapper.resolve(false);
/**
* # Router
* The router is responsible for mapping URLs to components.
* The `Router` is responsible for mapping URLs to components.
*
* You can see the state of the router by inspecting the read-only field `router.navigating`.
* This may be useful for showing a spinner, for instance.
*
* ## Concepts
*
* Routers and component instances have a 1:1 correspondence.
*
* The router holds reference to a number of "outlets." An outlet is a placeholder that the
* router dynamically fills in depending on the current URL.
* The router holds reference to a number of {@link RouterOutlet}.
* An outlet is a placeholder that the router dynamically fills in depending on the current URL.
*
* When the router navigates from a URL, it must first recognizes it and serialize it into an
* `Instruction`.