Internal
The TargetState constructor
Note: Do not construct a TargetState
manually.
To create a TargetState
, use the [[StateService.target]] factory method.
The StateRegistry to use to look up the _definition
An identifier for a state. Either a fully-qualified state name, or the object used to define the state.
Parameters for the target state
Transition options.
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
Static
is
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:
Many ng-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
TargetState
class normalizes those options.A
TargetState
may be valid (the state being targeted exists in the registry) or invalid (the state being targeted is not registered).