HttpClient is an evolution of the existing Angular HTTP API, which exists alongside of it in a separate package, @angular/common/http. This structure ensures that existing codebases can slowly migrate to the new API. The new API improves significantly on the ergonomics and features of the legacy API. A partial list of new features includes: * Typed, synchronous response body access, including support for JSON body types * JSON is an assumed default and no longer needs to be explicitly parsed * Interceptors allow middleware logic to be inserted into the pipeline * Immutable request/response objects * Progress events for both request upload and response download * Post-request verification & flush based testing framework
		
			
				
	
	
		
			309 lines
		
	
	
		
			9.3 KiB
		
	
	
	
		
			TypeScript
		
	
	
	
	
	
			
		
		
	
	
			309 lines
		
	
	
		
			9.3 KiB
		
	
	
	
		
			TypeScript
		
	
	
	
	
	
| /** @stable */
 | |
| export declare const APP_BASE_HREF: InjectionToken<string>;
 | |
| 
 | |
| /** @stable */
 | |
| export declare class AsyncPipe implements OnDestroy, PipeTransform {
 | |
|     constructor(_ref: ChangeDetectorRef);
 | |
|     ngOnDestroy(): void;
 | |
|     transform<T>(obj: Promise<T>): T | null;
 | |
|     transform<T>(obj: Observable<T>): T | null;
 | |
|     transform<T>(obj: undefined): undefined;
 | |
|     transform<T>(obj: null): null;
 | |
| }
 | |
| 
 | |
| /** @stable */
 | |
| export declare class CommonModule {
 | |
| }
 | |
| 
 | |
| /** @stable */
 | |
| export declare class CurrencyPipe implements PipeTransform {
 | |
|     constructor(_locale: string);
 | |
|     transform(value: any, currencyCode?: string, symbolDisplay?: boolean, digits?: string): string | null;
 | |
| }
 | |
| 
 | |
| /** @stable */
 | |
| export declare class DatePipe implements PipeTransform {
 | |
|     constructor(_locale: string);
 | |
|     transform(value: any, pattern?: string): string | null;
 | |
| }
 | |
| 
 | |
| /** @stable */
 | |
| export declare class DecimalPipe implements PipeTransform {
 | |
|     constructor(_locale: string);
 | |
|     transform(value: any, digits?: string): string | null;
 | |
| }
 | |
| 
 | |
| /** @stable */
 | |
| export declare const DOCUMENT: InjectionToken<Document>;
 | |
| 
 | |
| /** @stable */
 | |
| export declare class HashLocationStrategy extends LocationStrategy {
 | |
|     constructor(_platformLocation: PlatformLocation, _baseHref?: string);
 | |
|     back(): void;
 | |
|     forward(): void;
 | |
|     getBaseHref(): string;
 | |
|     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;
 | |
| }
 | |
| 
 | |
| /** @experimental */
 | |
| export declare class I18nPluralPipe implements PipeTransform {
 | |
|     constructor(_localization: NgLocalization);
 | |
|     transform(value: number, pluralMap: {
 | |
|         [count: string]: string;
 | |
|     }): string;
 | |
| }
 | |
| 
 | |
| /** @experimental */
 | |
| export declare class I18nSelectPipe implements PipeTransform {
 | |
|     transform(value: string | null | undefined, mapping: {
 | |
|         [key: string]: string;
 | |
|     }): string;
 | |
| }
 | |
| 
 | |
| /** @experimental */
 | |
| export declare function isPlatformBrowser(platformId: Object): boolean;
 | |
| 
 | |
| /** @experimental */
 | |
| export declare function isPlatformServer(platformId: Object): boolean;
 | |
| 
 | |
| /** @experimental */
 | |
| export declare function isPlatformWorkerApp(platformId: Object): boolean;
 | |
| 
 | |
| /** @experimental */
 | |
| export declare function isPlatformWorkerUi(platformId: Object): boolean;
 | |
| 
 | |
| /** @stable */
 | |
| export declare class JsonPipe implements PipeTransform {
 | |
|     transform(value: any): string;
 | |
| }
 | |
| 
 | |
| /** @stable */
 | |
| export declare class Location {
 | |
|     constructor(platformStrategy: LocationStrategy);
 | |
|     back(): void;
 | |
|     forward(): void;
 | |
|     go(path: string, query?: string): void;
 | |
|     isCurrentPathEqualTo(path: string, query?: string): boolean;
 | |
|     normalize(url: string): string;
 | |
|     path(includeHash?: boolean): string;
 | |
|     prepareExternalUrl(url: string): string;
 | |
|     replaceState(path: string, query?: string): void;
 | |
|     subscribe(onNext: (value: PopStateEvent) => void, onThrow?: ((exception: any) => void) | null, onReturn?: (() => void) | null): Object;
 | |
|     static joinWithSlash(start: string, end: string): string;
 | |
|     static normalizeQueryParams(params: string): string;
 | |
|     static stripTrailingSlash(url: string): string;
 | |
| }
 | |
| 
 | |
| /** @experimental */
 | |
| export declare const LOCATION_INITIALIZED: InjectionToken<Promise<any>>;
 | |
| 
 | |
| /** @experimental */
 | |
| export interface LocationChangeEvent {
 | |
|     type: string;
 | |
| }
 | |
| 
 | |
| /** @experimental */
 | |
| export interface LocationChangeListener {
 | |
|     (e: LocationChangeEvent): any;
 | |
| }
 | |
| 
 | |
| /** @stable */
 | |
| export declare abstract class LocationStrategy {
 | |
|     abstract back(): void;
 | |
|     abstract forward(): void;
 | |
|     abstract getBaseHref(): string;
 | |
|     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;
 | |
| }
 | |
| 
 | |
| /** @stable */
 | |
| export declare class LowerCasePipe implements PipeTransform {
 | |
|     transform(value: string): string;
 | |
| }
 | |
| 
 | |
| /** @stable */
 | |
| export declare class NgClass implements DoCheck {
 | |
|     klass: string;
 | |
|     ngClass: string | string[] | Set<string> | {
 | |
|         [klass: string]: any;
 | |
|     };
 | |
|     constructor(_iterableDiffers: IterableDiffers, _keyValueDiffers: KeyValueDiffers, _ngEl: ElementRef, _renderer: Renderer);
 | |
|     ngDoCheck(): void;
 | |
| }
 | |
| 
 | |
| /** @experimental */
 | |
| 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;
 | |
| }
 | |
| 
 | |
| /** @deprecated */
 | |
| export declare const NgFor: typeof NgForOf;
 | |
| 
 | |
| /** @stable */
 | |
| export declare class NgForOf<T> implements DoCheck, OnChanges {
 | |
|     ngForOf: NgIterable<T>;
 | |
|     ngForTemplate: TemplateRef<NgForOfContext<T>>;
 | |
|     ngForTrackBy: TrackByFunction<T>;
 | |
|     constructor(_viewContainer: ViewContainerRef, _template: TemplateRef<NgForOfContext<T>>, _differs: IterableDiffers);
 | |
|     ngDoCheck(): void;
 | |
|     ngOnChanges(changes: SimpleChanges): void;
 | |
| }
 | |
| 
 | |
| /** @stable */
 | |
| 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);
 | |
| }
 | |
| 
 | |
| /** @stable */
 | |
| export declare class NgIf {
 | |
|     ngIf: any;
 | |
|     ngIfElse: TemplateRef<NgIfContext>;
 | |
|     ngIfThen: TemplateRef<NgIfContext>;
 | |
|     constructor(_viewContainer: ViewContainerRef, templateRef: TemplateRef<NgIfContext>);
 | |
| }
 | |
| 
 | |
| /** @stable */
 | |
| export declare class NgIfContext {
 | |
|     $implicit: any;
 | |
|     ngIf: any;
 | |
| }
 | |
| 
 | |
| /** @experimental */
 | |
| export declare class NgLocaleLocalization extends NgLocalization {
 | |
|     protected locale: string;
 | |
|     constructor(locale: string);
 | |
|     getPluralCategory(value: any): string;
 | |
| }
 | |
| 
 | |
| /** @experimental */
 | |
| export declare abstract class NgLocalization {
 | |
|     abstract getPluralCategory(value: any): string;
 | |
| }
 | |
| 
 | |
| /** @experimental */
 | |
| export declare class NgPlural {
 | |
|     ngPlural: number;
 | |
|     constructor(_localization: NgLocalization);
 | |
|     addCase(value: string, switchView: SwitchView): void;
 | |
| }
 | |
| 
 | |
| /** @experimental */
 | |
| export declare class NgPluralCase {
 | |
|     value: string;
 | |
|     constructor(value: string, template: TemplateRef<Object>, viewContainer: ViewContainerRef, ngPlural: NgPlural);
 | |
| }
 | |
| 
 | |
| /** @stable */
 | |
| export declare class NgStyle implements DoCheck {
 | |
|     ngStyle: {
 | |
|         [key: string]: string;
 | |
|     };
 | |
|     constructor(_differs: KeyValueDiffers, _ngEl: ElementRef, _renderer: Renderer);
 | |
|     ngDoCheck(): void;
 | |
| }
 | |
| 
 | |
| /** @stable */
 | |
| export declare class NgSwitch {
 | |
|     ngSwitch: any;
 | |
| }
 | |
| 
 | |
| /** @stable */
 | |
| export declare class NgSwitchCase implements DoCheck {
 | |
|     ngSwitchCase: any;
 | |
|     constructor(viewContainer: ViewContainerRef, templateRef: TemplateRef<Object>, ngSwitch: NgSwitch);
 | |
|     ngDoCheck(): void;
 | |
| }
 | |
| 
 | |
| /** @stable */
 | |
| export declare class NgSwitchDefault {
 | |
|     constructor(viewContainer: ViewContainerRef, templateRef: TemplateRef<Object>, ngSwitch: NgSwitch);
 | |
| }
 | |
| 
 | |
| /** @experimental */
 | |
| export declare class NgTemplateOutlet implements OnChanges {
 | |
|     /** @deprecated */ ngOutletContext: Object;
 | |
|     ngTemplateOutlet: TemplateRef<any>;
 | |
|     ngTemplateOutletContext: Object;
 | |
|     constructor(_viewContainerRef: ViewContainerRef);
 | |
|     ngOnChanges(changes: SimpleChanges): void;
 | |
| }
 | |
| 
 | |
| /** @stable */
 | |
| export declare class PathLocationStrategy extends LocationStrategy {
 | |
|     constructor(_platformLocation: PlatformLocation, href?: string);
 | |
|     back(): void;
 | |
|     forward(): void;
 | |
|     getBaseHref(): string;
 | |
|     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;
 | |
| }
 | |
| 
 | |
| /** @stable */
 | |
| export declare class PercentPipe implements PipeTransform {
 | |
|     constructor(_locale: string);
 | |
|     transform(value: any, digits?: string): string | null;
 | |
| }
 | |
| 
 | |
| /** @stable */
 | |
| export declare abstract class PlatformLocation {
 | |
|     readonly abstract hash: string;
 | |
|     readonly abstract pathname: string;
 | |
|     readonly abstract search: string;
 | |
|     abstract back(): void;
 | |
|     abstract forward(): void;
 | |
|     abstract getBaseHrefFromDOM(): string;
 | |
|     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;
 | |
| }
 | |
| 
 | |
| /** @experimental */
 | |
| export interface PopStateEvent {
 | |
|     pop?: boolean;
 | |
|     type?: string;
 | |
|     url?: string;
 | |
| }
 | |
| 
 | |
| /** @stable */
 | |
| export declare class SlicePipe implements PipeTransform {
 | |
|     transform(value: any, start: number, end?: number): any;
 | |
| }
 | |
| 
 | |
| /** @stable */
 | |
| export declare class TitleCasePipe implements PipeTransform {
 | |
|     transform(value: string): string;
 | |
| }
 | |
| 
 | |
| /** @stable */
 | |
| export declare class UpperCasePipe implements PipeTransform {
 | |
|     transform(value: string): string;
 | |
| }
 | |
| 
 | |
| /** @stable */
 | |
| export declare const VERSION: Version;
 |