Encapsulate the target (destination) state/params/options of a [[Transition]].

This class is frequently used to redirect a transition to a new destination.

See:

  • [[HookResult]]
  • [[TransitionHookFn]]
  • [[TransitionService.onStart]]

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 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).

Constructors

  • Internal

    The TargetState constructor

    Note: Do not construct a TargetState manually. To create a TargetState, use the [[StateService.target]] factory method.

    Parameters

    • _stateRegistry: any

      The StateRegistry to use to look up the _definition

    • _identifier: any

      An identifier for a state. Either a fully-qualified state name, or the object used to define the state.

    • _params: any

      Parameters for the target state

    • _options: any

      Transition options.

    Returns TargetState

Properties

_definition: any
_identifier: any
_options: any
_params: any
_stateRegistry: any

Methods

  • Returns a copy of this TargetState, using the specified Transition Options.

    Parameters

    • options: any

      the new options to use

    • replace: boolean = false

      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 TargetState

  • Returns a copy of this TargetState, using the specified parameter values.

    Parameters

    • params: any

      the new parameter values to use

    • replace: boolean = false

      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 TargetState

  • Returns a copy of this TargetState which targets a different state. The new TargetState has the same parameter values and transition options.

    Parameters

    • state: any

      The new state that should be targeted

    Returns TargetState

  • Returns true if the object has a state property that might be a state or state name

    Parameters

    • obj: any

    Returns boolean