Options
All
  • Public
  • Public/Protected
  • All
Menu

A helper type for describing the shape of the object passed to the argument of a RouteHandler.

This class has is a state machine for that is used by the Router class to determine the next step in the navigation process.

Hierarchy

  • NavigationContext

Index

Constructors

Methods

Constructors

Methods

  • abort(error?: any): void
  • Signals the router to stop the navigation and that an error has occurred. Accepts an optional error object. The router will any error handlers registered with the Router method

    Parameters

    • Optional error: any

    Returns void

  • ok(): void
  • Signals the router that the route handler has handled the navigation and stop finding the next route handler.

    Returns void

  • redirect(path: string): void
  • Signals the router that the route handlers wants to redirect to a new path.

    Parameters

    • path: string

      The path to redirect to.

    Returns void

Generated using TypeDoc