AngularTS
    Preparing search index...

    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:

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

    Index

    Methods

    $state error exists identifier name options params state toString valid withOptions withParams withState

    Methods

    • The internal state object (if it was found)

      Returns StateObject | undefined

    • If the object is invalid, returns the reason why

      Returns string | undefined

    • True if the target state was found

      Returns boolean

    • Returns string

    • True if the object is valid

      Returns boolean

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

      Parameters

      • options: TransitionOptions

        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

      A new TargetState instance which targets the same state with the desired options

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

      Parameters

      • params: RawParams

        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

      A new TargetState instance which targets the same state with the desired parameters

    • 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

      A new TargetState instance which targets the desired state

    Settings
    Member Visibility

    On This Page
    Methods