
Previously there wasn't a way to retrieve `history.state` from the `Location` service. The only time the framework exposed this value was in navigation events. This meant if you weren't using the Angular router, there wasn't a way to get access to this `history.state` value other than going directly to the DOM. This PR adds an API to retrieve the value of `history.state`. This will be useful and needed to provide a backwards-compatible `Location` service that can emulate AngularJS's `$location` service since we will need to be able to read the state data in order to produce AngularJS location transition events. This feature will additionally be useful to any application that wants to access state data through Angular rather than going directly to the DOM APIs. PR Close #30055
454 lines
15 KiB
TypeScript
454 lines
15 KiB
TypeScript
export declare const APP_BASE_HREF: InjectionToken<string>;
|
|
|
|
export declare class AsyncPipe implements OnDestroy, PipeTransform {
|
|
constructor(_ref: ChangeDetectorRef);
|
|
ngOnDestroy(): void;
|
|
transform<T>(obj: Observable<T> | null | undefined): T | null;
|
|
transform<T>(obj: Promise<T> | null | undefined): T | null;
|
|
transform<T>(obj: undefined): undefined;
|
|
transform<T>(obj: null): null;
|
|
}
|
|
|
|
export declare class CommonModule {
|
|
}
|
|
|
|
export declare class CurrencyPipe implements PipeTransform {
|
|
constructor(_locale: string);
|
|
transform(value: any, currencyCode?: string, display?: 'code' | 'symbol' | 'symbol-narrow' | string | boolean, digitsInfo?: string, locale?: string): string | null;
|
|
}
|
|
|
|
export declare class DatePipe implements PipeTransform {
|
|
constructor(locale: string);
|
|
transform(value: any, format?: string, timezone?: string, locale?: string): string | null;
|
|
}
|
|
|
|
export declare class DecimalPipe implements PipeTransform {
|
|
constructor(_locale: string);
|
|
transform(value: any, digitsInfo?: string, locale?: string): string | null;
|
|
}
|
|
|
|
export declare class DeprecatedCurrencyPipe implements PipeTransform {
|
|
constructor(_locale: string);
|
|
transform(value: any, currencyCode?: string, symbolDisplay?: boolean, digits?: string): string | null;
|
|
}
|
|
|
|
export declare class DeprecatedDatePipe implements PipeTransform {
|
|
constructor(_locale: string);
|
|
transform(value: any, pattern?: string): string | null;
|
|
}
|
|
|
|
export declare class DeprecatedDecimalPipe implements PipeTransform {
|
|
constructor(_locale: string);
|
|
transform(value: any, digits?: string): string | null;
|
|
}
|
|
|
|
/** @deprecated */
|
|
export declare class DeprecatedI18NPipesModule {
|
|
}
|
|
|
|
export declare class DeprecatedPercentPipe implements PipeTransform {
|
|
constructor(_locale: string);
|
|
transform(value: any, digits?: string): string | null;
|
|
}
|
|
|
|
export declare const DOCUMENT: InjectionToken<Document>;
|
|
|
|
export declare function formatCurrency(value: number, locale: string, currency: string, currencyCode?: string, digitsInfo?: string): string;
|
|
|
|
export declare function formatDate(value: string | number | Date, format: string, locale: string, timezone?: string): string;
|
|
|
|
export declare function formatNumber(value: number, locale: string, digitsInfo?: string): string;
|
|
|
|
export declare function formatPercent(value: number, locale: string, digitsInfo?: string): string;
|
|
|
|
export declare enum FormatWidth {
|
|
Short = 0,
|
|
Medium = 1,
|
|
Long = 2,
|
|
Full = 3
|
|
}
|
|
|
|
export declare enum FormStyle {
|
|
Format = 0,
|
|
Standalone = 1
|
|
}
|
|
|
|
export declare function getCurrencySymbol(code: string, format: 'wide' | 'narrow', locale?: string): string;
|
|
|
|
export declare function getLocaleCurrencyName(locale: string): string | null;
|
|
|
|
export declare function getLocaleCurrencySymbol(locale: string): string | null;
|
|
|
|
export declare function getLocaleDateFormat(locale: string, width: FormatWidth): string;
|
|
|
|
export declare function getLocaleDateTimeFormat(locale: string, width: FormatWidth): string;
|
|
|
|
export declare function getLocaleDayNames(locale: string, formStyle: FormStyle, width: TranslationWidth): string[];
|
|
|
|
export declare function getLocaleDayPeriods(locale: string, formStyle: FormStyle, width: TranslationWidth): [string, string];
|
|
|
|
export declare function getLocaleEraNames(locale: string, width: TranslationWidth): [string, string];
|
|
|
|
export declare function getLocaleExtraDayPeriodRules(locale: string): (Time | [Time, Time])[];
|
|
|
|
export declare function getLocaleExtraDayPeriods(locale: string, formStyle: FormStyle, width: TranslationWidth): string[];
|
|
|
|
export declare function getLocaleFirstDayOfWeek(locale: string): WeekDay;
|
|
|
|
export declare function getLocaleId(locale: string): string;
|
|
|
|
export declare function getLocaleMonthNames(locale: string, formStyle: FormStyle, width: TranslationWidth): string[];
|
|
|
|
export declare function getLocaleNumberFormat(locale: string, type: NumberFormatStyle): string;
|
|
|
|
export declare function getLocaleNumberSymbol(locale: string, symbol: NumberSymbol): string;
|
|
|
|
export declare function getLocalePluralCase(locale: string): (value: number) => Plural;
|
|
|
|
export declare function getLocaleTimeFormat(locale: string, width: FormatWidth): string;
|
|
|
|
export declare function getLocaleWeekEndRange(locale: string): [WeekDay, WeekDay];
|
|
|
|
export declare function getNumberOfCurrencyDigits(code: string): number;
|
|
|
|
export declare class HashLocationStrategy extends LocationStrategy {
|
|
constructor(_platformLocation: PlatformLocation, _baseHref?: string);
|
|
back(): void;
|
|
forward(): void;
|
|
getBaseHref(): string;
|
|
getState(): unknown;
|
|
onPopState(fn: LocationChangeListener): void;
|
|
path(includeHash?: boolean): string;
|
|
prepareExternalUrl(internal: string): string;
|
|
pushState(state: any, title: string, path: string, queryParams: string): void;
|
|
replaceState(state: any, title: string, path: string, queryParams: string): void;
|
|
}
|
|
|
|
export declare class I18nPluralPipe implements PipeTransform {
|
|
constructor(_localization: NgLocalization);
|
|
transform(value: number, pluralMap: {
|
|
[count: string]: string;
|
|
}, locale?: string): string;
|
|
}
|
|
|
|
export declare class I18nSelectPipe implements PipeTransform {
|
|
transform(value: string | null | undefined, mapping: {
|
|
[key: string]: string;
|
|
}): string;
|
|
}
|
|
|
|
export declare function isPlatformBrowser(platformId: Object): boolean;
|
|
|
|
export declare function isPlatformServer(platformId: Object): boolean;
|
|
|
|
export declare function isPlatformWorkerApp(platformId: Object): boolean;
|
|
|
|
export declare function isPlatformWorkerUi(platformId: Object): boolean;
|
|
|
|
export declare class JsonPipe implements PipeTransform {
|
|
transform(value: any): string;
|
|
}
|
|
|
|
export interface KeyValue<K, V> {
|
|
key: K;
|
|
value: V;
|
|
}
|
|
|
|
export declare class KeyValuePipe implements PipeTransform {
|
|
constructor(differs: KeyValueDiffers);
|
|
transform<K, V>(input: null, compareFn?: (a: KeyValue<K, V>, b: KeyValue<K, V>) => number): null;
|
|
transform<V>(input: {
|
|
[key: string]: V;
|
|
} | Map<string, V>, compareFn?: (a: KeyValue<string, V>, b: KeyValue<string, V>) => number): Array<KeyValue<string, V>>;
|
|
transform<V>(input: {
|
|
[key: number]: V;
|
|
} | Map<number, V>, compareFn?: (a: KeyValue<number, V>, b: KeyValue<number, V>) => number): Array<KeyValue<number, V>>;
|
|
transform<K, V>(input: Map<K, V>, compareFn?: (a: KeyValue<K, V>, b: KeyValue<K, V>) => number): Array<KeyValue<K, V>>;
|
|
}
|
|
|
|
export declare class Location {
|
|
constructor(platformStrategy: LocationStrategy);
|
|
back(): void;
|
|
forward(): void;
|
|
getState(): unknown;
|
|
go(path: string, query?: string, state?: any): void;
|
|
isCurrentPathEqualTo(path: string, query?: string): boolean;
|
|
normalize(url: string): string;
|
|
path(includeHash?: boolean): string;
|
|
prepareExternalUrl(url: string): string;
|
|
replaceState(path: string, query?: string, state?: any): void;
|
|
subscribe(onNext: (value: PopStateEvent) => void, onThrow?: ((exception: any) => void) | null, onReturn?: (() => void) | null): SubscriptionLike;
|
|
static joinWithSlash(start: string, end: string): string;
|
|
static normalizeQueryParams(params: string): string;
|
|
static stripTrailingSlash(url: string): string;
|
|
}
|
|
|
|
export declare const LOCATION_INITIALIZED: InjectionToken<Promise<any>>;
|
|
|
|
export interface LocationChangeEvent {
|
|
state: any;
|
|
type: string;
|
|
}
|
|
|
|
export interface LocationChangeListener {
|
|
(event: LocationChangeEvent): any;
|
|
}
|
|
|
|
export declare abstract class LocationStrategy {
|
|
abstract back(): void;
|
|
abstract forward(): void;
|
|
abstract getBaseHref(): string;
|
|
abstract getState(): unknown;
|
|
abstract onPopState(fn: LocationChangeListener): void;
|
|
abstract path(includeHash?: boolean): string;
|
|
abstract prepareExternalUrl(internal: string): string;
|
|
abstract pushState(state: any, title: string, url: string, queryParams: string): void;
|
|
abstract replaceState(state: any, title: string, url: string, queryParams: string): void;
|
|
}
|
|
|
|
export declare class LowerCasePipe implements PipeTransform {
|
|
transform(value: string): string;
|
|
}
|
|
|
|
export declare class NgClass extends NgClassBase implements DoCheck {
|
|
klass: string;
|
|
ngClass: string | string[] | Set<string> | {
|
|
[klass: string]: any;
|
|
};
|
|
constructor(delegate: NgClassImpl);
|
|
ngDoCheck(): void;
|
|
}
|
|
|
|
export declare class NgClassBase {
|
|
protected _delegate: NgClassImpl;
|
|
constructor(_delegate: NgClassImpl);
|
|
getValue(): {
|
|
[key: string]: any;
|
|
} | null;
|
|
static ngDirectiveDef: any;
|
|
}
|
|
|
|
export declare class NgComponentOutlet implements OnChanges, OnDestroy {
|
|
ngComponentOutlet: Type<any>;
|
|
ngComponentOutletContent: any[][];
|
|
ngComponentOutletInjector: Injector;
|
|
ngComponentOutletNgModuleFactory: NgModuleFactory<any>;
|
|
constructor(_viewContainerRef: ViewContainerRef);
|
|
ngOnChanges(changes: SimpleChanges): void;
|
|
ngOnDestroy(): void;
|
|
}
|
|
|
|
export declare class NgForOf<T> implements DoCheck {
|
|
ngForOf: NgIterable<T>;
|
|
ngForTemplate: TemplateRef<NgForOfContext<T>>;
|
|
ngForTrackBy: TrackByFunction<T>;
|
|
constructor(_viewContainer: ViewContainerRef, _template: TemplateRef<NgForOfContext<T>>, _differs: IterableDiffers);
|
|
ngDoCheck(): void;
|
|
static ngTemplateContextGuard<T>(dir: NgForOf<T>, ctx: any): ctx is NgForOfContext<T>;
|
|
}
|
|
|
|
export declare class NgForOfContext<T> {
|
|
$implicit: T;
|
|
count: number;
|
|
readonly even: boolean;
|
|
readonly first: boolean;
|
|
index: number;
|
|
readonly last: boolean;
|
|
ngForOf: NgIterable<T>;
|
|
readonly odd: boolean;
|
|
constructor($implicit: T, ngForOf: NgIterable<T>, index: number, count: number);
|
|
}
|
|
|
|
export declare class NgIf {
|
|
ngIf: any;
|
|
ngIfElse: TemplateRef<NgIfContext> | null;
|
|
ngIfThen: TemplateRef<NgIfContext> | null;
|
|
constructor(_viewContainer: ViewContainerRef, templateRef: TemplateRef<NgIfContext>);
|
|
static ngTemplateGuard_ngIf<E>(dir: NgIf, expr: E): expr is NonNullable<E>;
|
|
}
|
|
|
|
export declare class NgIfContext {
|
|
$implicit: any;
|
|
ngIf: any;
|
|
}
|
|
|
|
export declare class NgLocaleLocalization extends NgLocalization {
|
|
/** @deprecated */ protected deprecatedPluralFn?: ((locale: string, value: string | number) => Plural) | null | undefined;
|
|
protected locale: string;
|
|
constructor(locale: string,
|
|
/** @deprecated */ deprecatedPluralFn?: ((locale: string, value: string | number) => Plural) | null | undefined);
|
|
getPluralCategory(value: any, locale?: string): string;
|
|
}
|
|
|
|
export declare abstract class NgLocalization {
|
|
abstract getPluralCategory(value: any, locale?: string): string;
|
|
}
|
|
|
|
export declare class NgPlural {
|
|
ngPlural: number;
|
|
constructor(_localization: NgLocalization);
|
|
addCase(value: string, switchView: SwitchView): void;
|
|
}
|
|
|
|
export declare class NgPluralCase {
|
|
value: string;
|
|
constructor(value: string, template: TemplateRef<Object>, viewContainer: ViewContainerRef, ngPlural: NgPlural);
|
|
}
|
|
|
|
export declare class NgStyle extends NgStyleBase implements DoCheck {
|
|
ngStyle: {
|
|
[klass: string]: any;
|
|
} | null;
|
|
constructor(delegate: NgStyleImpl);
|
|
ngDoCheck(): void;
|
|
}
|
|
|
|
export declare class NgStyleBase {
|
|
protected _delegate: NgStyleImpl;
|
|
constructor(_delegate: NgStyleImpl);
|
|
getValue(): {
|
|
[key: string]: any;
|
|
} | null;
|
|
static ngDirectiveDef: any;
|
|
}
|
|
|
|
export declare class NgSwitch {
|
|
ngSwitch: any;
|
|
}
|
|
|
|
export declare class NgSwitchCase implements DoCheck {
|
|
ngSwitchCase: any;
|
|
constructor(viewContainer: ViewContainerRef, templateRef: TemplateRef<Object>, ngSwitch: NgSwitch);
|
|
ngDoCheck(): void;
|
|
}
|
|
|
|
export declare class NgSwitchDefault {
|
|
constructor(viewContainer: ViewContainerRef, templateRef: TemplateRef<Object>, ngSwitch: NgSwitch);
|
|
}
|
|
|
|
export declare class NgTemplateOutlet implements OnChanges {
|
|
ngTemplateOutlet: TemplateRef<any> | null;
|
|
ngTemplateOutletContext: Object | null;
|
|
constructor(_viewContainerRef: ViewContainerRef);
|
|
ngOnChanges(changes: SimpleChanges): void;
|
|
}
|
|
|
|
export declare enum NumberFormatStyle {
|
|
Decimal = 0,
|
|
Percent = 1,
|
|
Currency = 2,
|
|
Scientific = 3
|
|
}
|
|
|
|
export declare enum NumberSymbol {
|
|
Decimal = 0,
|
|
Group = 1,
|
|
List = 2,
|
|
PercentSign = 3,
|
|
PlusSign = 4,
|
|
MinusSign = 5,
|
|
Exponential = 6,
|
|
SuperscriptingExponent = 7,
|
|
PerMille = 8,
|
|
Infinity = 9,
|
|
NaN = 10,
|
|
TimeSeparator = 11,
|
|
CurrencyDecimal = 12,
|
|
CurrencyGroup = 13
|
|
}
|
|
|
|
export declare class PathLocationStrategy extends LocationStrategy {
|
|
constructor(_platformLocation: PlatformLocation, href?: string);
|
|
back(): void;
|
|
forward(): void;
|
|
getBaseHref(): string;
|
|
getState(): unknown;
|
|
onPopState(fn: LocationChangeListener): void;
|
|
path(includeHash?: boolean): string;
|
|
prepareExternalUrl(internal: string): string;
|
|
pushState(state: any, title: string, url: string, queryParams: string): void;
|
|
replaceState(state: any, title: string, url: string, queryParams: string): void;
|
|
}
|
|
|
|
export declare class PercentPipe implements PipeTransform {
|
|
constructor(_locale: string);
|
|
transform(value: any, digitsInfo?: string, locale?: string): string | null;
|
|
}
|
|
|
|
export declare abstract class PlatformLocation {
|
|
abstract readonly hash: string;
|
|
abstract readonly pathname: string;
|
|
abstract readonly search: string;
|
|
abstract back(): void;
|
|
abstract forward(): void;
|
|
abstract getBaseHrefFromDOM(): string;
|
|
abstract getState(): unknown;
|
|
abstract onHashChange(fn: LocationChangeListener): void;
|
|
abstract onPopState(fn: LocationChangeListener): void;
|
|
abstract pushState(state: any, title: string, url: string): void;
|
|
abstract replaceState(state: any, title: string, url: string): void;
|
|
}
|
|
|
|
export declare enum Plural {
|
|
Zero = 0,
|
|
One = 1,
|
|
Two = 2,
|
|
Few = 3,
|
|
Many = 4,
|
|
Other = 5
|
|
}
|
|
|
|
export interface PopStateEvent {
|
|
pop?: boolean;
|
|
state?: any;
|
|
type?: string;
|
|
url?: string;
|
|
}
|
|
|
|
export declare function registerLocaleData(data: any, localeId?: string | any, extraData?: any): void;
|
|
|
|
export declare class SlicePipe implements PipeTransform {
|
|
transform(value: any, start: number, end?: number): any;
|
|
}
|
|
|
|
export declare type Time = {
|
|
hours: number;
|
|
minutes: number;
|
|
};
|
|
|
|
export declare class TitleCasePipe implements PipeTransform {
|
|
transform(value: string): string;
|
|
}
|
|
|
|
export declare enum TranslationWidth {
|
|
Narrow = 0,
|
|
Abbreviated = 1,
|
|
Wide = 2,
|
|
Short = 3
|
|
}
|
|
|
|
export declare class UpperCasePipe implements PipeTransform {
|
|
transform(value: string): string;
|
|
}
|
|
|
|
export declare const VERSION: Version;
|
|
|
|
export declare abstract class ViewportScroller {
|
|
abstract getScrollPosition(): [number, number];
|
|
abstract scrollToAnchor(anchor: string): void;
|
|
abstract scrollToPosition(position: [number, number]): void;
|
|
abstract setHistoryScrollRestoration(scrollRestoration: 'auto' | 'manual'): void;
|
|
abstract setOffset(offset: [number, number] | (() => [number, number])): void;
|
|
static ngInjectableDef: never;
|
|
}
|
|
|
|
export declare enum WeekDay {
|
|
Sunday = 0,
|
|
Monday = 1,
|
|
Tuesday = 2,
|
|
Wednesday = 3,
|
|
Thursday = 4,
|
|
Friday = 5,
|
|
Saturday = 6
|
|
}
|