24eb8389d2
- ts-api-guardian will now error if a new public symbol is added with a stability marker (`@stable`, `@experimental`, `@deprecated`) - DomEventsPlugin and KeyEventsPlugin were removed from public api surface - these classes is an implementation detail - deprecated BROWSER_PROVIDERS was removed completely - `@angular/compiler` was removed from the ts-api-guardian check since this package shouldn't contain anything that users need to directly import - the rest of the api surface was conservatively marked as stable or experimental BREAKING CHANGES: DomEventsPlugin and KeyEventsPlugin previously exported from core are no longer public - these classes are implementation detail. Previously deprecated BROWSER_PROVIDERS was completely removed from platform-browser. Closes #9236 Closes #9235 Ref #9234
64 lines
2.0 KiB
TypeScript
64 lines
2.0 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
|
|
*/
|
|
|
|
/**
|
|
* 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, the default `PlatformLocation` is {@link
|
|
* BrowserPlatformLocation},
|
|
* however when you run your app in a WebWorker you use {@link WebWorkerPlatformLocation}.
|
|
*
|
|
* 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.
|
|
*
|
|
* @stable
|
|
*/
|
|
export abstract class PlatformLocation {
|
|
abstract getBaseHrefFromDOM(): string;
|
|
abstract onPopState(fn: UrlChangeListener): void;
|
|
abstract onHashChange(fn: UrlChangeListener): void;
|
|
|
|
get pathname(): string { return null; }
|
|
get search(): string { return null; }
|
|
get hash(): string { return null; }
|
|
|
|
abstract replaceState(state: any, title: string, url: string): void;
|
|
|
|
abstract pushState(state: any, title: string, url: string): void;
|
|
|
|
abstract forward(): void;
|
|
|
|
abstract back(): void;
|
|
}
|
|
|
|
/**
|
|
* A serializable version of the event from onPopState or onHashChange
|
|
*
|
|
* @experimental
|
|
*/
|
|
export interface UrlChangeEvent { type: string; }
|
|
|
|
/**
|
|
* @experimental
|
|
*/
|
|
export interface UrlChangeListener { (e: UrlChangeEvent): any; }
|