• Overview
@angular/common

PlatformNavigation

Class

This class wraps the platform Navigation API which allows server-specific and test implementations.

API

    
      abstract class PlatformNavigation implements Navigation {  abstract entries(): NavigationHistoryEntry[];  abstract currentEntry: any;  abstract updateCurrentEntry(options: NavigationUpdateCurrentEntryOptions): void;  abstract transition: any;  abstract canGoBack: boolean;  abstract canGoForward: boolean;  abstract navigate(url: string, options?: any): NavigationResult;  abstract reload(options?: any): NavigationResult;  abstract traverseTo(key: string, options?: any): NavigationResult;  abstract back(options?: any): NavigationResult;  abstract forward(options?: any): NavigationResult;  abstract onnavigate: ((this: Navigation, ev: NavigateEvent) => any) | null;  abstract onnavigatesuccess: ((this: Navigation, ev: Event) => any) | null;  abstract onnavigateerror: ((this: Navigation, ev: ErrorEvent) => any) | null;  abstract oncurrententrychange: ((this: Navigation, ev: NavigationCurrentEntryChangeEvent) => any) | null;  abstract addEventListener(type: unknown, listener: unknown, options?: unknown): void;  abstract removeEventListener(type: unknown, listener: unknown, options?: unknown): void;  abstract dispatchEvent(event: Event): boolean;}
    
    

entries

NavigationHistoryEntry[]
@returnsNavigationHistoryEntry[]

currentEntry

any

updateCurrentEntry

void
@paramoptionsNavigationUpdateCurrentEntryOptions
@returnsvoid

transition

any

canGoBack

boolean

canGoForward

boolean

reload

NavigationResult
@paramoptionsany
@returnsNavigationResult

traverseTo

NavigationResult
@paramkeystring
@paramoptionsany
@returnsNavigationResult

back

NavigationResult
@paramoptionsany
@returnsNavigationResult

forward

NavigationResult
@paramoptionsany
@returnsNavigationResult

onnavigate

((this: Navigation, ev: NavigateEvent) => any) | null

onnavigatesuccess

((this: Navigation, ev: Event) => any) | null

onnavigateerror

((this: Navigation, ev: ErrorEvent) => any) | null

oncurrententrychange

((this: Navigation, ev: NavigationCurrentEntryChangeEvent) => any) | null

addEventListener

void
@paramtypeunknown
@paramlistenerunknown
@paramoptionsunknown
@returnsvoid

removeEventListener

void
@paramtypeunknown
@paramlistenerunknown
@paramoptionsunknown
@returnsvoid

dispatchEvent

boolean
@parameventEvent
@returnsboolean

Description

This class wraps the platform Navigation API which allows server-specific and test implementations.

Browser support is limited, so this API may not be available in all environments, may contain bugs, and is experimental.

Jump to details