PlatformLocation — Angular

Этот класс не следует использовать напрямую разработчикам приложений. Вместо него используйте Location.

API

abstract class PlatformLocation {
  abstract getBaseHrefFromDOM(): string;
  abstract getState(): unknown;
  abstract onPopState(fn: LocationChangeListener): VoidFunction;
  abstract onHashChange(fn: LocationChangeListener): VoidFunction;
  abstract readonly href: string;
  abstract readonly protocol: string;
  abstract readonly hostname: string;
  abstract readonly port: string;
  abstract readonly pathname: string;
  abstract readonly search: string;
  abstract readonly hash: string;
  abstract replaceState(state: any, title: string, url: string): void;
  abstract pushState(state: any, title: string, url: string): void;
  abstract forward(): void;
  abstract back(): void;
  optional historyGo(relativePosition: number): void;
}

getBaseHrefFromDOM

string

@returnsstring

getState

unknown

@returnsunknown

onPopState

VoidFunction

Возвращает функцию, которая при выполнении удаляет обработчик события popstate.

@paramfnLocationChangeListener

@returnsVoidFunction

onHashChange

VoidFunction

Возвращает функцию, которая при выполнении удаляет обработчик события hashchange.

@paramfnLocationChangeListener

@returnsVoidFunction

href

string

protocol

string

hostname

string

port

string

pathname

string

search

string

hash

string

replaceState

void

@paramstateany

@paramtitlestring

@paramurlstring

@returnsvoid

pushState

void

@paramstateany

@paramtitlestring

@paramurlstring

@returnsvoid

forward

void

@returnsvoid

back

void

@returnsvoid

historyGo

void

@paramrelativePositionnumber

@returnsvoid

Описание

Этот класс не следует использовать напрямую разработчикам приложений. Вместо него используйте Location.

PlatformLocation инкапсулирует все вызовы DOM API, что позволяет Router быть независимым от платформы. Это означает, что для разных платформ, поддерживаемых Angular, можно использовать разные реализации PlatformLocation. Например, @angular/platform-browser предоставляет реализацию, предназначенную для браузерной среды, а @angular/platform-server — реализацию, подходящую для серверного рендеринга.

Класс PlatformLocation напрямую используется всеми реализациями LocationStrategy, когда им необходимо взаимодействовать с DOM API, такими как pushState, popState и т. д.

В свою очередь, LocationStrategy используется сервисом Location, который напрямую применяется Router для перехода между маршрутами. Поскольку все взаимодействия между Router / Location / LocationStrategy и DOM API проходят через класс PlatformLocation, все они не зависят от платформы.