API docs issues

[adamreisnz]

The example for otherwise in the docs seems to be incorrect. I tried the following:

.config(function($urlRouterProvider) {
  $urlRouterProvider.otherwise((url, router) => {
    router.stateService.go('error', {error: 'page-not-found'});
  });
})

But this resulted in an error Cannot read property 'stateService' of undefined.
I then moved the logic to the run cycle instead:

.run(function($urlRouter) {
  $urlRouter.otherwise((url, router) => {
    router.stateService.go('error', {error: 'page-not-found'});
  });
})

This led to Cannot read property 'go' of undefined.

Upon analysis of parameters, I found that a boolean value is inserted as the first parameter to the function. Changing to:

.run(function($urlRouter) {
  $urlRouter.otherwise((bool, url, router) => {
    router.stateService.go('error', {error: 'page-not-found'});
  });
})

Finally did the trick.

So not sure what that first parameter is, but it's missing from the example. In addition, the return statement in the example is superfluous.

Further, the docs here should probably state:

Returns the state that the transition is going to

E.g. to instead of from.

[aj-dev]

$urlRouterProvider and $urlRouter are deprecated.

Try using $urlServiceProvider.rules.otherwise((matchValue, url, router) => {});.

All parameters are optional. See here https://ui-router.github.io/ng1/docs/latest/interfaces/url.urlrulehandlerfn.html

[christopherthielen]

The API for $urlRouter.otherwise and $urlRouterProvider.otherwise are not the same.

The docs for $urlRouter service (injected at runtime) are correct. For $urlRouterProvider (injected at config time), follow this chain:

injectables -> $urlRouterProvider -> $urlRouterProvider.otherwise

The reason for this is:

In angular-ui-router, we've always used .config(function($urlRouterProvider) {}) to add rules like otherwise. Those rules were passed the $injector, i.e.

$urlRouterProvider.otherwise(function ($injector, $location) {
    return '/a/valid/url';
  }));

In core ui-router, we're dropping the $injector wherever possible, but the ng1 code still should support it for backwards compatibility. Since $urlRouterProvider is only an ng1 concept, it keeps the OLD API for use in .config() blocks.

[adamreisnz]

Thanks for the clarification, I'll review the doc changes and refactor my code accordingly