Hopiu/angular.js
1
0
Fork 0
mirror of https://github.com/Hopiu/angular.js.git synced 2026-03-17 07:40:22 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs($routeProvider): document route.resolve rejection

Browse source 
Add documentation that the $routeChangeError event is fired when a
route resolve promise is rejected

Closes #4447
This commit is contained in:
Josh Schumacher 2013-10-15 16:56:09 -07:00 committed by Pete Bacon Darwin
parent 3c05e36e79
commit 3b046c9eaa
1 changed files with 6 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
src/ngRoute/route.js
View file

@ -89,9 +89,12 @@ function $RouteProvider(){
* `$location.path()` by applying the current route
*
* - `resolve` - `{Object.<string, function>=}` - An optional map of dependencies which should
* be injected into the controller. If any of these dependencies are promises, they will be
* resolved and converted to a value before the controller is instantiated and the
* `$routeChangeSuccess` event is fired. The map object is:
* be injected into the controller. If any of these dependencies are promises, the router will
* wait for them all to be resolved or one to be rejected before the controller is instantiated.
* If all the promises are resolved successfully, the values of the resolved promises are injected
* and {@link ngRoute.$route#$routeChangeSuccess $routeChangeSuccess} event is fired.
* If any of the promises are rejected the {@link ngRoute.$route#$routeChangeError $routeChangeError}
* event is fired. The map object is:
*
* - `key` – `{string}`: a name of a dependency to be injected into the controller.
* - `factory` - `{string|function}`: If `string` then it is an alias for a service.