W3cubDocs

/Angular

NavigationCancel

class final

An event triggered when a navigation is canceled, directly or indirectly. This can happen for several reasons including when a route guard returns false or initiates a redirect by returning a UrlTree.

class NavigationCancel extends RouterEvent {
  constructor(id: number, url: string, reason: string, code?: NavigationCancellationCode)
  type: EventType.NavigationCancel
  reason: string
  code?: NavigationCancellationCode
  toString(): string

  // inherited from router/RouterEvent
  constructor(id: number, url: string)
  id: number
  url: string
}

See also

Constructor

constructor(id: number, url: string, reason: string, code?: NavigationCancellationCode)

Parameters
id number
url string
reason string

A description of why the navigation was cancelled. For debug purposes only. Use code instead for a stable cancellation reason that can be used in production.
code NavigationCancellationCode

A code to indicate why the navigation was canceled. This cancellation code is stable for the reason and can be relied on whereas the reason string could change and should not be used in production.

Optional. Default is undefined.

Properties

Property Description
type: EventType.NavigationCancel Read-Only
reason: string Declared in Constructor

A description of why the navigation was cancelled. For debug purposes only. Use code instead for a stable cancellation reason that can be used in production.
code?: NavigationCancellationCode Read-Only Declared in Constructor

A code to indicate why the navigation was canceled. This cancellation code is stable for the reason and can be relied on whereas the reason string could change and should not be used in production.

Methods

toString()

toString(): string

Parameters

There are no parameters.

Returns

string

© 2010–2023 Google, Inc.
Licensed under the Creative Commons Attribution License 4.0.
https://angular.io/api/router/NavigationCancel