4b96a58c5a
These are no longer needed as stable docs are computed as those that do not have `@experimental` or `@deprecated` tags. PR Close #23210
71 lines
2.3 KiB
TypeScript
71 lines
2.3 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright Google Inc. All Rights Reserved.
|
|
*
|
|
* Use of this source code is governed by an MIT-style license that can be
|
|
* found in the LICENSE file at https://angular.io/license
|
|
*/
|
|
|
|
import {InjectionToken} from '@angular/core';
|
|
/**
|
|
* This class should not be used directly by an application developer. Instead, use
|
|
* {@link Location}.
|
|
*
|
|
* `PlatformLocation` encapsulates all calls to DOM apis, which allows the Router to be platform
|
|
* agnostic.
|
|
* This means that we can have different implementation of `PlatformLocation` for the different
|
|
* platforms that angular supports. For example, `@angular/platform-browser` provides an
|
|
* implementation specific to the browser environment, while `@angular/platform-webworker` provides
|
|
* one suitable for use with web workers.
|
|
*
|
|
* The `PlatformLocation` class is used directly by all implementations of {@link LocationStrategy}
|
|
* when they need to interact with the DOM apis like pushState, popState, etc...
|
|
*
|
|
* {@link LocationStrategy} in turn is used by the {@link Location} service which is used directly
|
|
* by the {@link Router} in order to navigate between routes. Since all interactions between {@link
|
|
* Router} /
|
|
* {@link Location} / {@link LocationStrategy} and DOM apis flow through the `PlatformLocation`
|
|
* class they are all platform independent.
|
|
*
|
|
*
|
|
*/
|
|
export abstract class PlatformLocation {
|
|
abstract getBaseHrefFromDOM(): string;
|
|
abstract onPopState(fn: LocationChangeListener): void;
|
|
abstract onHashChange(fn: LocationChangeListener): void;
|
|
|
|
abstract get pathname(): string;
|
|
abstract get search(): string;
|
|
abstract get 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;
|
|
}
|
|
|
|
/**
|
|
* @description Indicates when a location is initialized.
|
|
* @experimental
|
|
*/
|
|
export const LOCATION_INITIALIZED = new InjectionToken<Promise<any>>('Location Initialized');
|
|
|
|
/**
|
|
* @description
|
|
* A serializable version of the event from `onPopState` or `onHashChange`
|
|
*
|
|
* @experimental
|
|
*/
|
|
export interface LocationChangeEvent {
|
|
type: string;
|
|
state: any;
|
|
}
|
|
|
|
/**
|
|
* @experimental
|
|
*/
|
|
export interface LocationChangeListener { (e: LocationChangeEvent): any; }
|