docs: http api doc edit (#31613)

PR Close #31613
This commit is contained in:
Judy Bogart
2019-07-16 17:25:53 -07:00
committed by Misko Hevery
parent 59c3700c8c
commit 27997a16c0
6 changed files with 105 additions and 47 deletions

View File

@ -38,8 +38,7 @@ function getResponseUrl(xhr: any): string|null {
export abstract class XhrFactory { abstract build(): XMLHttpRequest; }
/**
* A factory for @{link HttpXhrBackend} that uses the `XMLHttpRequest` browser API.
*
* A factory for `HttpXhrBackend` that uses the `XMLHttpRequest` browser API.
*
*/
@Injectable()
@ -59,8 +58,9 @@ interface PartialResponse {
}
/**
* An `HttpBackend` which uses the XMLHttpRequest API to send
* requests to a backend server.
* Uses `XMLHttpRequest` to send requests to a backend server.
* @see `HttpHandler`
* @see `JsonpClientBackend`
*
* @publicApi
*/
@ -69,7 +69,9 @@ export class HttpXhrBackend implements HttpBackend {
constructor(private xhrFactory: XhrFactory) {}
/**
* Process a request and return a stream of response events.
* Processes a request and returns a stream of response events.
* @param req The request object.
* @returns An observable of the response events.
*/
handle(req: HttpRequest<any>): Observable<HttpEvent<any>> {
// Quick check to give a better error message when a user attempts to use