HookRegistry | UI-Router
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HookRegistry

Mixin class acts as a Transition Hook registry.

Holds the registered HookFn objects. Exposes functions to register new hooks.

This is a Mixin class which can be applied to other objects.

The hook registration functions are onBefore, onStart, onEnter, onRetain, onExit, onFinish, onSuccess, onError.

This class is mixed into both the TransitionService and every Transition object. Global hooks are added to the TransitionService. Since each Transition is itself a HookRegistry, hooks can also be added to individual Transitions (note: the hook criteria still must match the Transition).

Hierarchy

  • HookRegistry

Implements

Index

Properties

onBefore: function
inheritdoc

Type declaration

onEnter: function
inheritdoc

Type declaration

onError: function
inheritdoc

Type declaration

onExit: function
inheritdoc

Type declaration

onFinish: function
inheritdoc

Type declaration

onRetain: function
inheritdoc

Type declaration

onStart: function
inheritdoc

Type declaration

onSuccess: function
inheritdoc

Type declaration

Methods

  • getHooks(name: string): Array<IEventHook>

Object literals

_transitionEvents: object
onBefore: Array<undefined>
onEnter: Array<undefined>
onError: Array<undefined>
onExit: Array<undefined>
onFinish: Array<undefined>
onRetain: Array<undefined>
onStart: Array<undefined>
onSuccess: Array<undefined>

Generated using TypeDoc