Add jsdoc for IUrlRouterService.

This commit is contained in:
John Jeffery
2014-05-21 10:08:37 +10:00
parent 3ffc175119
commit 2d444c9c93
+10
View File
@@ -93,6 +93,16 @@ declare module ng.ui {
}
interface IUrlRouterService {
/*
* Triggers an update; the same update that happens when the address bar
* url changes, aka $locationChangeSuccess.
*
* This method is useful when you need to use preventDefault() on the
* $locationChangeSuccess event, perform some custom logic (route protection,
* auth, config, redirection, etc) and then finally proceed with the transition
* by calling $urlRouter.sync().
*
*/
sync(): void;
}
}