TransitionEventType | @uirouter/core
Options
Menu

Class TransitionEventType

This class defines a type of hook, such as onBefore or onEnter. Plugins can define custom hook types, such as sticky states does for onInactive.

interalapi

Hierarchy

  • TransitionEventType

Index

Constructors

Properties

Constructors

  • new TransitionEventType(name: string, hookPhase: TransitionHookPhase.CREATE | TransitionHookPhase.BEFORE | TransitionHookPhase.RUN | TransitionHookPhase.SUCCESS | TransitionHookPhase.ERROR, hookOrder: number, criteriaMatchPath: PathType, reverseSort?: boolean, getResultHandler?: GetResultHandler, getErrorHandler?: GetErrorHandler, synchronous?: boolean): TransitionEventType

  • Parameters

    • name string
    • hookPhase TransitionHookPhase.CREATE | TransitionHookPhase.BEFORE | TransitionHookPhase.RUN | TransitionHookPhase.SUCCESS | TransitionHookPhase.ERROR
    • hookOrder number
    • criteriaMatchPath PathType
    • reverseSort: Default value  boolean = false
    • getResultHandler: Default value  GetResultHandler = TransitionHook.HANDLE_RESULT
    • getErrorHandler: Default value  GetErrorHandler = TransitionHook.REJECT_ERROR
    • synchronous: Default value  boolean = false

    Returns TransitionEventType

Properties

criteriaMatchPath: PathType
getErrorHandler: GetErrorHandler
getResultHandler: GetResultHandler
hookOrder: number
hookPhase: TransitionHookPhase.CREATE | TransitionHookPhase.BEFORE | TransitionHookPhase.RUN | TransitionHookPhase.SUCCESS | TransitionHookPhase.ERROR
name: string
reverseSort: boolean
synchronous: boolean

Generated using TypeDoc