TargetState | @uirouter/core
Options
Menu

Class TargetState

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

Hierarchy

  • TargetState

Index

Constructors

Properties

Methods

Constructors

  • The TargetState constructor

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

    Parameters

    • _stateRegistry StateRegistry
      :

      The StateRegistry to use to look up the _definition

    • _identifier StateOrName
      :

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

    • _params: Optional  RawParams
      :

      Parameters for the target state

    • _options: Optional  TransitionOptions
      :

      Transition options.

    Returns TargetState

Properties

_definition: StateObject
_identifier: StateOrName

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

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

_options: TransitionOptions
_params: RawParams
_stateRegistry: StateRegistry

The StateRegistry to use to look up the _definition

The StateRegistry to use to look up the _definition

Methods

  • $state(): StateObject

  • The internal state object (if it was found)

  • The internal state object (if it was found)

    Returns StateObject

  • error(): string

  • If the object is invalid, returns the reason why

  • If the object is invalid, returns the reason why

    Returns string

  • exists(): boolean

  • True if the target state was found

  • True if the target state was found

    Returns boolean

  • identifier(): StateOrName

  • The identifier used when creating this TargetState

  • The identifier used when creating this TargetState

    Returns StateOrName

  • name(): string

  • The name of the state this object targets

  • The name of the state this object targets

    Returns string

  • params(): RawParams

  • The target parameter values

  • The target parameter values

    Returns RawParams

  • The internal state declaration (if it was found)

    Returns StateDeclaration

  • toString(): string

  • Returns string

  • valid(): boolean

  • True if the object is valid

  • True if the object is valid

    Returns boolean

  • withOptions(options: TransitionOptions, replace?: boolean): TargetState

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

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

    Parameters

    • options TransitionOptions
      :

      the new options to use

    • replace: Default value  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

  • withParams(params: RawParams, replace?: boolean): TargetState

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

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

    Parameters

    • params RawParams
      :

      the new parameter values to use

    • replace: Default value  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

  • withState(state: StateOrName): TargetState

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

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

    Parameters

    • state StateOrName
      :

      The new state that should be targeted

    Returns TargetState

  • isDef(obj: any): boolean

  • 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

    Parameters

    • obj any

    Returns boolean

Generated using TypeDoc