37797e2b4e
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
94 lines
2.6 KiB
TypeScript
94 lines
2.6 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 {Inject, NgModule, Optional} from '@angular/core';
|
|
|
|
import {HttpBackend, HttpHandler} from './backend';
|
|
import {HttpClient} from './client';
|
|
import {HTTP_INTERCEPTORS, HttpInterceptor, HttpInterceptorHandler} from './interceptor';
|
|
import {JsonpCallbackContext, JsonpClientBackend, JsonpInterceptor} from './jsonp';
|
|
import {BrowserXhr, HttpXhrBackend, XhrFactory} from './xhr';
|
|
|
|
|
|
/**
|
|
* Constructs an `HttpHandler` that applies a bunch of `HttpInterceptor`s
|
|
* to a request before passing it to the given `HttpBackend`.
|
|
*
|
|
* Meant to be used as a factory function within `HttpClientModule`.
|
|
*
|
|
* @experimental
|
|
*/
|
|
export function interceptingHandler(
|
|
backend: HttpBackend, interceptors: HttpInterceptor[] | null = []): HttpHandler {
|
|
if (!interceptors) {
|
|
return backend;
|
|
}
|
|
return interceptors.reduceRight(
|
|
(next, interceptor) => new HttpInterceptorHandler(next, interceptor), backend);
|
|
}
|
|
|
|
/**
|
|
* Factory function that determines where to store JSONP callbacks.
|
|
*
|
|
* Ordinarily JSONP callbacks are stored on the `window` object, but this may not exist
|
|
* in test environments. In that case, callbacks are stored on an anonymous object instead.
|
|
*
|
|
* @experimental
|
|
*/
|
|
export function jsonpCallbackContext(): Object {
|
|
if (typeof window === 'object') {
|
|
return window;
|
|
}
|
|
return {};
|
|
}
|
|
|
|
/**
|
|
* `NgModule` which provides the `HttpClient` and associated services.
|
|
*
|
|
* Interceptors can be added to the chain behind `HttpClient` by binding them
|
|
* to the multiprovider for `HTTP_INTERCEPTORS`.
|
|
*
|
|
* @experimental
|
|
*/
|
|
@NgModule({
|
|
providers: [
|
|
HttpClient,
|
|
// HttpHandler is the backend + interceptors and is constructed
|
|
// using the interceptingHandler factory function.
|
|
{
|
|
provide: HttpHandler,
|
|
useFactory: interceptingHandler,
|
|
deps: [HttpBackend, [new Optional(), new Inject(HTTP_INTERCEPTORS)]],
|
|
},
|
|
HttpXhrBackend,
|
|
{provide: HttpBackend, useExisting: HttpXhrBackend},
|
|
BrowserXhr,
|
|
{provide: XhrFactory, useExisting: BrowserXhr},
|
|
],
|
|
})
|
|
export class HttpClientModule {
|
|
}
|
|
|
|
/**
|
|
* `NgModule` which enables JSONP support in `HttpClient`.
|
|
*
|
|
* Without this module, Jsonp requests will reach the backend
|
|
* with method JSONP, where they'll be rejected.
|
|
*
|
|
* @experimental
|
|
*/
|
|
@NgModule({
|
|
providers: [
|
|
JsonpClientBackend,
|
|
{provide: JsonpCallbackContext, useFactory: jsonpCallbackContext},
|
|
{provide: HTTP_INTERCEPTORS, useClass: JsonpInterceptor, multi: true},
|
|
],
|
|
})
|
|
export class HttpClientJsonpModule {
|
|
}
|