Prototypally inherits from StateDeclaration.abstract
Prototypally inherits from StateDeclaration.data
Note: This is the only field on the StateDeclaration which is mutated.
The definition object's data field is replaced with a new object
which prototypally inherits from the parent state definition's data field.
An object containing the parent States' names as keys and true as their values.
Prototypally inherits from StateDeclaration.lazyLoad
The name used to register the state
The nearest parent StateObject which has a URL
Prototypally inherits from StateDeclaration.onEnter
Prototypally inherits from StateDeclaration.onExit
Prototypally inherits from StateDeclaration.onRetain
The parameters for the state, built from the URL and StateDeclaration.params
The parent StateObject
The parent StateObject objects from this state up to the root
Prototypally inherits from StateDeclaration.redirectTo
A list of Resolvable objects. The internal representation of resolve.
Prototypally inherits from StateDeclaration.resolve
Prototypally inherits from StateDeclaration.resolvePolicy
The original StateDeclaration used to build this StateObject.
Note: this object also prototypally inherits from the self declaration object.
A compiled URLMatcher which detects when the state's URL is matched
The views for the state.
Note: @uirouter/core does not register a builder for views.
The framework specific code should register a views builder.
Returns a dot-separated name of the state.
Returns true if the provided parameter is the same state.
Compares the identity of the state against the passed value, which is either an object
reference to the actual State instance, the original definition object passed to
$stateProvider.state(), or the fully-qualified name.
Can be one of (a) a State instance, (b) an object that was passed
into $stateProvider.state(), (c) the fully-qualified name of a state as a string.
Returns true if ref matches the current State instance.
Gets the state's Param objects
Gets the list of Param objects owned by the state.
If opts.inherit is true, it also includes the ancestor states' Param objects.
If opts.matchingKeys exists, returns only Params whose id is a key on the matchingKeys object
options
Returns the root node of this state's tree.
The root of this state's tree.
Create a state object to put the private/internal implementation details onto. The object's prototype chain looks like: (Internal State Object) -> (Copy of State.prototype) -> (State Declaration object) -> (State Declaration's prototype...)
the user-supplied State Declaration
an internal State object
Predicate which returns true if the object is an internal StateObject object
Predicate which returns true if the object is an class with @State() decorator
Predicate which returns true if the object is a StateDeclaration object
Generated using TypeDoc
Internal representation of a UI-Router state.
Instances of this class are created when a StateDeclaration is registered with the StateRegistry.
A registered StateDeclaration is augmented with a getter ([[StateDeclaration.$$state]]) which returns the corresponding StateObject object.
This class prototypally inherits from the corresponding StateDeclaration. Each of its own properties (i.e.,
hasOwnProperty) are built using builders from the StateBuilder.