The TargetState constructor
The TargetState constructor
Note: Do not construct a TargetState manually.
To create a TargetState, use the StateService.target factory method.
An identifier for a state. Either a fully-qualified state name, or the object used to define the state.
The internal state representation, if exists.
Parameters for the target state
Transition options.
The internal state representation, if exists.
An identifier for a state. Either a fully-qualified state name, or the object used to define the state.
Transition options.
The internal state object (if it was found)
The internal state object (if it was found)
If the object is invalid, returns the reason why
If the object is invalid, returns the reason why
True if the target state was found
True if the target state was found
The identifier used when creating this TargetState
The identifier used when creating this TargetState
The name of the state this object targets
The name of the state this object targets
The target options
The target options
The target parameter values
The target parameter values
The internal state declaration (if it was found)
The internal state declaration (if it was found)
True if the object is valid
True if the object is valid
Returns true if the object has a state property that might be a state or state name
Returns true if the object has a state property that might be a state or state name
Generated using TypeDoc
Encapsulate the target (destination) state/params/options of a Transition.
This class is frequently used to redirect a transition to a new destination.
See:
To create a
TargetState, use StateService.target.This class wraps:
1) an identifier for a state 2) a set of parameters 3) and transition options 4) the registered state object (the StateDeclaration)
Many UI-Router APIs such as StateService.go take a StateOrName argument which can either be a state object (a StateDeclaration or State) or a state name (a string). The
TargetStateclass normalizes those options.A
TargetStatemay be valid (the state being targeted exists in the registry) or invalid (the state being targeted is not registered).