NavigationCancel
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
Parameters
|
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?: 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 |
Methods
toString() |
---|
ParametersThere are no parameters. Returns
|