From 1539c64fb0619eb3c9dd317f754e01ee1d3ce159 Mon Sep 17 00:00:00 2001 From: Tzimpoulas Nikos Date: Thu, 26 Nov 2020 21:22:28 +0200 Subject: [PATCH] docs(common): change HTTPResponse to HttpResponse (#39860) PR Close #39860 --- packages/common/http/src/client.ts | 136 ++++++++++++++--------------- 1 file changed, 68 insertions(+), 68 deletions(-) diff --git a/packages/common/http/src/client.ts b/packages/common/http/src/client.ts index 29bf07935e..cb15e4ee91 100644 --- a/packages/common/http/src/client.ts +++ b/packages/common/http/src/client.ts @@ -265,13 +265,13 @@ export class HttpClient { /** * Constructs a request which interprets the body as an `ArrayBuffer` - * and returns the full `HTTPResponse`. + * and returns the full `HttpResponse`. * * @param method The HTTP method. * @param url The endpoint URL. * @param options The HTTP options to send with the request. * - * @return An `Observable` of the `HTTPResponse`, with the response body as an `ArrayBuffer`. + * @return An `Observable` of the `HttpResponse`, with the response body as an `ArrayBuffer`. */ request(method: string, url: string, options: { body?: any, @@ -282,13 +282,13 @@ export class HttpClient { }): Observable>; /** - * Constructs a request which interprets the body as a `Blob` and returns the full `HTTPResponse`. + * Constructs a request which interprets the body as a `Blob` and returns the full `HttpResponse`. * * @param method The HTTP method. * @param url The endpoint URL. * @param options The HTTP options to send with the request. * - * @return An `Observable` of the `HTTPResponse`, with the response body of type `Blob`. + * @return An `Observable` of the `HttpResponse`, with the response body of type `Blob`. */ request(method: string, url: string, options: { body?: any, @@ -300,7 +300,7 @@ export class HttpClient { /** * Constructs a request which interprets the body as a text stream and returns the full - * `HTTPResponse`. + * `HttpResponse`. * * @param method The HTTP method. * @param url The endpoint URL. @@ -318,13 +318,13 @@ export class HttpClient { /** * Constructs a request which interprets the body as a JSON object and returns the full - * `HTTPResponse`. + * `HttpResponse`. * * @param method The HTTP method. * @param url The endpoint URL. * @param options The HTTP options to send with the request. * - * @return An `Observable` of the full `HTTPResponse`, + * @return An `Observable` of the full `HttpResponse`, * with the response body of type `Object`. */ request(method: string, url: string, options: { @@ -338,13 +338,13 @@ export class HttpClient { /** * Constructs a request which interprets the body as a JSON object and returns - * the full `HTTPResponse` with the response body in the requested type. + * the full `HttpResponse` with the response body in the requested type. * * @param method The HTTP method. * @param url The endpoint URL. * @param options The HTTP options to send with the request. * - * @return An `Observable` of the full `HTTPResponse`, with the response body of type `R`. + * @return An `Observable` of the full `HttpResponse`, with the response body of type `R`. */ request(method: string, url: string, options: { body?: any, @@ -357,13 +357,13 @@ export class HttpClient { /** * Constructs a request which interprets the body as a JSON object and returns the full - * `HTTPResponse` as a JSON object. + * `HttpResponse` as a JSON object. * * @param method The HTTP method. * @param url The endpoint URL. * @param options The HTTP options to send with the request. * - * @return An `Observable` of the `HTTPResponse`, with the response body of type `Object`. + * @return An `Observable` of the `HttpResponse`, with the response body of type `Object`. */ request(method: string, url: string, options?: { body?: any, @@ -383,7 +383,7 @@ export class HttpClient { * @param url The endpoint URL. * @param options The HTTP options to send with the request. * - * @return An `Observable` of the `HTTPResponse`, with the response body of type `R`. + * @return An `Observable` of the `HttpResponse`, with the response body of type `R`. */ request(method: string, url: string, options?: { body?: any, @@ -697,12 +697,12 @@ export class HttpClient { /** * Constructs a `DELETE` request that interprets the body as an `ArrayBuffer` and returns - * the full `HTTPResponse`. + * the full `HttpResponse`. * * @param url The endpoint URL. * @param options The HTTP options to send with the request. * - * @return An `Observable` of the full `HTTPResponse`, with the response body as an `ArrayBuffer`. + * @return An `Observable` of the full `HttpResponse`, with the response body as an `ArrayBuffer`. */ delete(url: string, options: { headers?: HttpHeaders|{[header: string]: string | string[]}, observe: 'response', @@ -713,12 +713,12 @@ export class HttpClient { /** * Constructs a `DELETE` request that interprets the body as a `Blob` and returns the full - * `HTTPResponse`. + * `HttpResponse`. * * @param url The endpoint URL. * @param options The HTTP options to send with the request. * - * @return An `Observable` of the `HTTPResponse`, with the response body of type `Blob`. + * @return An `Observable` of the `HttpResponse`, with the response body of type `Blob`. */ delete(url: string, options: { headers?: HttpHeaders|{[header: string]: string | string[]}, observe: 'response', @@ -729,12 +729,12 @@ export class HttpClient { /** * Constructs a `DELETE` request that interprets the body as a text stream and - * returns the full `HTTPResponse`. + * returns the full `HttpResponse`. * * @param url The endpoint URL. * @param options The HTTP options to send with the request. * - * @return An `Observable` of the full `HTTPResponse`, with the response body of type string. + * @return An `Observable` of the full `HttpResponse`, with the response body of type string. */ delete(url: string, options: { headers?: HttpHeaders|{[header: string]: string | string[]}, observe: 'response', @@ -745,12 +745,12 @@ export class HttpClient { /** * Constructs a `DELETE` request the interprets the body as a JSON object and returns - * the full `HTTPResponse`. + * the full `HttpResponse`. * * @param url The endpoint URL. * @param options The HTTP options to send with the request. * - * @return An `Observable` of the `HTTPResponse`, with the response body of type `Object`. + * @return An `Observable` of the `HttpResponse`, with the response body of type `Object`. * */ delete(url: string, options: { @@ -763,12 +763,12 @@ export class HttpClient { /** * Constructs a `DELETE` request that interprets the body as a JSON object - * and returns the full `HTTPResponse`. + * and returns the full `HttpResponse`. * * @param url The endpoint URL. * @param options The HTTP options to send with the request. * - * @return An `Observable` of the `HTTPResponse`, with the response body of the requested type. + * @return An `Observable` of the `HttpResponse`, with the response body of the requested type. */ delete(url: string, options: { headers?: HttpHeaders|{[header: string]: string | string[]}, observe: 'response', @@ -803,7 +803,7 @@ export class HttpClient { * @param url The endpoint URL. * @param options The HTTP options to send with the request. * - * @return An `Observable` of the `HTTPResponse`, with response body in the requested type. + * @return An `Observable` of the `HttpResponse`, with response body in the requested type. */ delete(url: string, options?: { headers?: HttpHeaders|{[header: string]: string | string[]}, @@ -971,12 +971,12 @@ export class HttpClient { /** * Constructs a `GET` request that interprets the body as an `ArrayBuffer` and - * returns the full `HTTPResponse`. + * returns the full `HttpResponse`. * * @param url The endpoint URL. * @param options The HTTP options to send with the request. * - * @return An `Observable` of the `HTTPResponse` for the request, + * @return An `Observable` of the `HttpResponse` for the request, * with the response body as an `ArrayBuffer`. */ get(url: string, options: { @@ -988,12 +988,12 @@ export class HttpClient { /** * Constructs a `GET` request that interprets the body as a `Blob` and - * returns the full `HTTPResponse`. + * returns the full `HttpResponse`. * * @param url The endpoint URL. * @param options The HTTP options to send with the request. * - * @return An `Observable` of the `HTTPResponse` for the request, + * @return An `Observable` of the `HttpResponse` for the request, * with the response body as a `Blob`. */ get(url: string, options: { @@ -1005,12 +1005,12 @@ export class HttpClient { /** * Constructs a `GET` request that interprets the body as a text stream and - * returns the full `HTTPResponse`. + * returns the full `HttpResponse`. * * @param url The endpoint URL. * @param options The HTTP options to send with the request. * - * @return An `Observable` of the `HTTPResponse` for the request, + * @return An `Observable` of the `HttpResponse` for the request, * with the response body of type string. */ get(url: string, options: { @@ -1022,7 +1022,7 @@ export class HttpClient { /** * Constructs a `GET` request that interprets the body as a JSON object and - * returns the full `HTTPResponse`. + * returns the full `HttpResponse`. * * @param url The endpoint URL. * @param options The HTTP options to send with the request. @@ -1040,12 +1040,12 @@ export class HttpClient { /** * Constructs a `GET` request that interprets the body as a JSON object and - * returns the full `HTTPResponse`. + * returns the full `HttpResponse`. * * @param url The endpoint URL. * @param options The HTTP options to send with the request. * - * @return An `Observable` of the full `HTTPResponse` for the request, + * @return An `Observable` of the full `HttpResponse` for the request, * with a response body in the requested type. */ get(url: string, options: { @@ -1082,7 +1082,7 @@ export class HttpClient { * @param url The endpoint URL. * @param options The HTTP options to send with the request. * - * @return An `Observable` of the `HTTPResponse`, with a response body in the requested type. + * @return An `Observable` of the `HttpResponse`, with a response body in the requested type. */ get(url: string, options?: { headers?: HttpHeaders|{[header: string]: string | string[]}, @@ -1256,7 +1256,7 @@ export class HttpClient { * @param url The endpoint URL. * @param options The HTTP options to send with the request. * - * @return An `Observable` of the `HTTPResponse` for the request, + * @return An `Observable` of the `HttpResponse` for the request, * with the response body as an `ArrayBuffer`. */ head(url: string, options: { @@ -1268,12 +1268,12 @@ export class HttpClient { /** * Constructs a `HEAD` request that interprets the body as a `Blob` and returns - * the full `HTTPResponse`. + * the full `HttpResponse`. * * @param url The endpoint URL. * @param options The HTTP options to send with the request. * - * @return An `Observable` of the `HTTPResponse` for the request, + * @return An `Observable` of the `HttpResponse` for the request, * with the response body as a blob. */ head(url: string, options: { @@ -1285,12 +1285,12 @@ export class HttpClient { /** * Constructs a `HEAD` request that interprets the body as text stream - * and returns the full `HTTPResponse`. + * and returns the full `HttpResponse`. * * @param url The endpoint URL. * @param options The HTTP options to send with the request. * - * @return An `Observable` of the `HTTPResponse` for the request, + * @return An `Observable` of the `HttpResponse` for the request, * with the response body of type string. */ head(url: string, options: { @@ -1302,12 +1302,12 @@ export class HttpClient { /** * Constructs a `HEAD` request that interprets the body as a JSON object and - * returns the full `HTTPResponse`. + * returns the full `HttpResponse`. * * @param url The endpoint URL. * @param options The HTTP options to send with the request. * - * @return An `Observable` of the `HTTPResponse` for the request, + * @return An `Observable` of the `HttpResponse` for the request, * with the response body of type `Object`. */ head(url: string, options: { @@ -1320,12 +1320,12 @@ export class HttpClient { /** * Constructs a `HEAD` request that interprets the body as a JSON object - * and returns the full `HTTPResponse`. + * and returns the full `HttpResponse`. * * @param url The endpoint URL. * @param options The HTTP options to send with the request. * - * @return An `Observable` of the `HTTPResponse` for the request, + * @return An `Observable` of the `HttpResponse` for the request, * with a responmse body of the requested type. */ head(url: string, options: { @@ -1361,7 +1361,7 @@ export class HttpClient { * @param url The endpoint URL. * @param options The HTTP options to send with the request. * - * @return An `Observable` of the `HTTPResponse` for the request, + * @return An `Observable` of the `HttpResponse` for the request, * with a response body of the given type. */ head(url: string, options?: { @@ -1598,7 +1598,7 @@ export class HttpClient { /** * Constructs an `OPTIONS` request that interprets the body as a `Blob` - * and returns the full `HTTPResponse`. + * and returns the full `HttpResponse`. * * @param url The endpoint URL. * @param options HTTP options. @@ -1615,7 +1615,7 @@ export class HttpClient { /** * Constructs an `OPTIONS` request that interprets the body as text stream - * and returns the full `HTTPResponse`. + * and returns the full `HttpResponse`. * * @param url The endpoint URL. * @param options HTTP options. @@ -1632,7 +1632,7 @@ export class HttpClient { /** * Constructs an `OPTIONS` request that interprets the body as a JSON object - * and returns the full `HTTPResponse`. + * and returns the full `HttpResponse`. * * @param url The endpoint URL. * @param options HTTP options. @@ -1650,7 +1650,7 @@ export class HttpClient { /** * Constructs an `OPTIONS` request that interprets the body as a JSON object and - * returns the full `HTTPResponse`. + * returns the full `HttpResponse`. * * @param url The endpoint URL. * @param options HTTP options. @@ -1691,7 +1691,7 @@ export class HttpClient { * @param url The endpoint URL. * @param options HTTP options. * - * @return An `Observable` of the `HTTPResponse`, with a response body of the given type. + * @return An `Observable` of the `HttpResponse`, with a response body of the given type. */ options(url: string, options?: { headers?: HttpHeaders|{[header: string]: string | string[]}, @@ -1869,7 +1869,7 @@ export class HttpClient { /** * Constructs a `PATCH` request that interprets the body as an `ArrayBuffer` - * and returns the full `HTTPResponse`. + * and returns the full `HttpResponse`. * * @param url The endpoint URL. * @param body The resources to edit. @@ -1887,7 +1887,7 @@ export class HttpClient { /** * Constructs a `PATCH` request that interprets the body as a `Blob` and returns the full - * `HTTPResponse`. + * `HttpResponse`. * * @param url The endpoint URL. * @param body The resources to edit. @@ -1905,7 +1905,7 @@ export class HttpClient { /** * Constructs a `PATCH` request that interprets the body as a text stream and returns the - * full `HTTPResponse`. + * full `HttpResponse`. * * @param url The endpoint URL. * @param body The resources to edit. @@ -1923,7 +1923,7 @@ export class HttpClient { /** * Constructs a `PATCH` request that interprets the body as a JSON object - * and returns the full `HTTPResponse`. + * and returns the full `HttpResponse`. * * @param url The endpoint URL. * @param body The resources to edit. @@ -1942,7 +1942,7 @@ export class HttpClient { /** * Constructs a `PATCH` request that interprets the body as a JSON object - * and returns the full `HTTPResponse`. + * and returns the full `HttpResponse`. * * @param url The endpoint URL. * @param body The resources to edit. @@ -2167,7 +2167,7 @@ export class HttpClient { * @param body The content to replace with. * @param options HTTP options * - * @return An `Observable` of the `HTTPResponse` for the request, with the response body as an + * @return An `Observable` of the `HttpResponse` for the request, with the response body as an * `ArrayBuffer`. */ post(url: string, body: any|null, options: { @@ -2179,13 +2179,13 @@ export class HttpClient { /** * Constructs a `POST` request that interprets the body as a `Blob` and returns the full - * `HTTPResponse`. + * `HttpResponse`. * * @param url The endpoint URL. * @param body The content to replace with. * @param options HTTP options * - * @return An `Observable` of the `HTTPResponse` for the request, + * @return An `Observable` of the `HttpResponse` for the request, * with the response body as a `Blob`. */ post(url: string, body: any|null, options: { @@ -2197,13 +2197,13 @@ export class HttpClient { /** * Constructs a `POST` request that interprets the body as a text stream and returns - * the full `HTTPResponse`. + * the full `HttpResponse`. * * @param url The endpoint URL. * @param body The content to replace with. * @param options HTTP options * - * @return An `Observable` of the `HTTPResponse` for the request, + * @return An `Observable` of the `HttpResponse` for the request, * with a response body of type string. */ post(url: string, body: any|null, options: { @@ -2215,13 +2215,13 @@ export class HttpClient { /** * Constructs a `POST` request that interprets the body as a JSON object - * and returns the full `HTTPResponse`. + * and returns the full `HttpResponse`. * * @param url The endpoint URL. * @param body The content to replace with. * @param options HTTP options * - * @return An `Observable` of the `HTTPResponse` for the request, with a response body of type + * @return An `Observable` of the `HttpResponse` for the request, with a response body of type * `Object`. */ post(url: string, body: any|null, options: { @@ -2234,14 +2234,14 @@ export class HttpClient { /** * Constructs a `POST` request that interprets the body as a JSON object and returns the full - * `HTTPResponse`. + * `HttpResponse`. * * * @param url The endpoint URL. * @param body The content to replace with. * @param options HTTP options * - * @return An `Observable` of the `HTTPResponse` for the request, with a response body in the + * @return An `Observable` of the `HttpResponse` for the request, with a response body in the * requested type. */ post(url: string, body: any|null, options: { @@ -2279,7 +2279,7 @@ export class HttpClient { * @param body The content to replace with. * @param options HTTP options * - * @return An `Observable` of the `HTTPResponse` for the request, with a response body in the + * @return An `Observable` of the `HttpResponse` for the request, with a response body in the * requested type. */ post(url: string, body: any|null, options?: { @@ -2462,7 +2462,7 @@ export class HttpClient { * @param body The resources to add/update. * @param options HTTP options * - * @return An `Observable` of the `HTTPResponse` for the request, with the response body as an + * @return An `Observable` of the `HttpResponse` for the request, with the response body as an * `ArrayBuffer`. */ put(url: string, body: any|null, options: { @@ -2480,7 +2480,7 @@ export class HttpClient { * @param body The resources to add/update. * @param options HTTP options * - * @return An `Observable` of the `HTTPResponse` for the request, + * @return An `Observable` of the `HttpResponse` for the request, * with the response body as a `Blob`. */ put(url: string, body: any|null, options: { @@ -2498,7 +2498,7 @@ export class HttpClient { * @param body The resources to add/update. * @param options HTTP options * - * @return An `Observable` of the `HTTPResponse` for the request, with a response body of type + * @return An `Observable` of the `HttpResponse` for the request, with a response body of type * string. */ put(url: string, body: any|null, options: { @@ -2516,7 +2516,7 @@ export class HttpClient { * @param body The resources to add/update. * @param options HTTP options * - * @return An `Observable` of the `HTTPResponse` for the request, with a response body + * @return An `Observable` of the `HttpResponse` for the request, with a response body * of type 'Object`. */ put(url: string, body: any|null, options: { @@ -2535,7 +2535,7 @@ export class HttpClient { * @param body The resources to add/update. * @param options HTTP options * - * @return An `Observable` of the `HTTPResponse` for the request, + * @return An `Observable` of the `HttpResponse` for the request, * with a response body in the requested type. */ put(url: string, body: any|null, options: {