Constructors

Properties

isSuperseded: (() => boolean)
options: any
registeredHook: any
stateContext: any
transition: any
type: any

Methods

  • Return a Rejection promise if the transition is no longer current due a new transition has started and superseded this one.

    Returns any

  • This method handles the return value of a Transition Hook.

    A hook can return false (cancel), a TargetState (redirect), or a promise (which may later resolve to false or a redirect)

    This also handles "transition superseded" -- when a new transition was started while the hook was still running

    Parameters

    • result: any

    Returns any

  • These GetResultHandler(s) are used by [[invokeHook]] below Each HookType chooses a GetResultHandler (See: [[TransitionService._defineCoreEvents]])

    Parameters

    • hook: any

    Returns ((result: any) => any)

      • (result): any
      • Parameters

        • result: any

        Returns any

  • These GetErrorHandler(s) are used by [[invokeHook]] below Each HookType chooses a GetErrorHandler (See: [[TransitionService._defineCoreEvents]])

    Parameters

    • hook: any

    Returns ((error: any) => any)

      • (error): any
      • Parameters

        • error: any

        Returns any

  • If the result is a promise rejection, log it. Otherwise, ignore the result.

    Parameters

    • hook: any

    Returns ((result: any) => any)

      • (result): any
      • Parameters

        • result: any

        Returns any

  • Chains together an array of TransitionHooks.

    Given a list of [[TransitionHook]] objects, chains them together. Each hook is invoked after the previous one completes.

    var hooks: TransitionHook[] = getHooks();
    let promise: Promise<any> = TransitionHook.chain(hooks);

    promise.then(handleSuccess, handleError);

    Parameters

    • hooks: any

      the list of hooks to chain together

    • waitFor: any

      if provided, the chain is .then()'ed off this promise

    Returns any

    a Promise for sequentially invoking the hooks (in order)

  • Invokes all the provided TransitionHooks, in order. Each hook's return value is checked. If any hook returns a promise, then the rest of the hooks are chained off that promise, and the promise is returned. If no hook returns a promise, then all hooks are processed synchronously.

    Parameters

    • hooks: any

      the list of TransitionHooks to invoke

    • doneCallback: any

      a callback that is invoked after all the hooks have successfully completed

    Returns any

    a promise for the async result, or the result of the callback