UrlRuleHandlerFn | @uirouter/core
Options
Menu

Interface UrlRuleHandlerFn

Handler invoked when a rule is matched

The matched value from the rule's UrlRuleMatchFn is passed as the first argument The handler should return a string (to redirect), a TargetState/TargetStateDef, or void

If the handler returns a string, the url is replaced with the string. If the handler returns a TargetState, the target state is activated.

Hierarchy

  • UrlRuleHandlerFn

Callable

  • Handler invoked when a rule is matched

    The matched value from the rule's UrlRuleMatchFn is passed as the first argument The handler should return a string (to redirect), a TargetState/TargetStateDef, or void

    If the handler returns a string, the url is replaced with the string. If the handler returns a TargetState, the target state is activated.

    Parameters

    • matchValue: Optional  any
    • url: Optional  UrlParts
    • router: Optional  UIRouter

    Returns string | TargetState | TargetStateDef | void

Generated using TypeDoc