Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "router"

Index

Type aliases

historyModule

historyModule: object

Type declaration

  • action: HISTORY_ACTION
  • go: function
      • (n: number): void
      • Parameters

        • n: number

        Returns void

  • goBack: function
      • (): void
      • Returns void

  • goForward: function
      • (): void
      • Returns void

  • listen: function
  • location: HistoryLocation
  • push: function
      • (path: string): void
      • Parameters

        • path: string

        Returns void

  • replace: function
      • (path: string): void
      • Parameters

        • path: string

        Returns void

navigationGuardFunction

navigationGuardFunction: function

Type declaration

navigationGuardNextAction

navigationGuardNextAction: undefined | boolean | Error | string | object

Possible actions:

  • fn() or fn(true) = Continue.
  • fn(false) = Abort the navigation.
  • fn(Error) = Abort the navigation and trigger navigation error.
  • fn(url) or fn(RawLocation) = Break the navigation and resolve the new navigation.

onErrorCallback

onErrorCallback: function

Type declaration

    • (e: Error): void
    • Parameters

      • e: Error

      Returns void

onNavigationCallback

onNavigationCallback: function

Type declaration

Generated using TypeDoc