state | angular-ui-router

Module state

The state subsystem

This subsystem implements the ui-router state tree


Type aliases

BuilderFunction: function

Type declaration

OnInvalidCallback: function

Type declaration

RedirectToResult: string | TargetState | object

The return value of a redirectTo function

The return value of a redirectTo function

  • string: a state name
  • TargetState: a target state, parameters, and options
  • object: an object with a state name and parameters
StateOrName: string | State | StateDeclaration
StateRegistryListener: function

The signature for the callback function provided to StateRegistry.onStatesChanged.

The signature for the callback function provided to StateRegistry.onStatesChanged.

This callback receives two parameters:


a string; either "registered" or "deregistered"


the list of StateDeclarations that were registered (or deregistered).

Type declaration

    • Parameters

      Returns void


  • dataBuilder(state: State): any
  • getNavigableBuilder(isRoot: function): navigableBuilder
  • getParamsBuilder(paramFactory: ParamFactory): paramsBuilder
  • getUrlBuilder($urlMatcherFactoryProvider: UrlMatcherFactory, root: function): urlBuilder
  • includesBuilder(state: State): any
  • nameBuilder(state: State): string
  • parseUrl(url: string): any
  • This is a StateBuilder.builder function for the resolve: block on a StateDeclaration.

    When the StateBuilder builds a State object from a raw StateDeclaration, this builder validates the resolve property and converts it to a Resolvable array.

    resolve: input value can be:

    { // analyzed but not injected myFooResolve: function() { return "myFooData"; },

    // function.toString() parsed, "DependencyName" dep as string (not min-safe) myBarResolve: function(DependencyName) { return DependencyName.fetchSomethingAsPromise() },

    // Array split; "DependencyName" dep as string myBazResolve: [ "DependencyName", function(dep) { return dep.fetchSomethingAsPromise() },

    // Array split; DependencyType dep as token (compared using ===) myQuxResolve: [ DependencyType, function(dep) { return dep.fetchSometingAsPromise() },

    // val.$inject used as deps // where: // corgeResolve.$inject = ["DependencyName"]; // function corgeResolve(dep) { dep.fetchSometingAsPromise() } // then "DependencyName" dep as string myCorgeResolve: corgeResolve,

    // inject service by name // When a string is found, desugar creating a resolve that injects the named service myGraultResolve: "SomeService" }


    [ new Resolvable("myFooResolve", function() { return "myFooData" }), new Resolvable("myBarResolve", function(dep) { return dep.fetchSomethingAsPromise() }, [ "DependencyName" ]), { provide: "myBazResolve", useFactory: function(dep) { dep.fetchSomethingAsPromise() }, deps: [ "DependencyName" ] } ]


    Returns Resolvable[]

Generated using TypeDoc