The internal state object (if it was found)
If the object is invalid, returns the reason why
True if the target state was found
The identifier used when creating this TargetState
The name of the state this object targets
The target options
The target parameter values
The internal state declaration (if it was found)
True if the object is valid
Returns a copy of this TargetState, using the specified Transition Options.
the new options to use
When false (default) the new options will be merged with the current options. When true the options will be used instead of the current options.
Returns a copy of this TargetState, using the specified parameter values.
the new parameter values to use
When false (default) the new parameter values will be merged with the current values. When true the parameter values will be used instead of the current values.
Returns a copy of this TargetState which targets a different state. The new TargetState has the same parameter values and transition options.
The new state that should be targeted
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 StateObject) 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).