cargdev/angular
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(common): update docs for HttpClient methods (#38878)

Browse Source 
PR Close #38878
This commit is contained in:
Benjamin Qin 2020-09-17 10:50:51 +09:00 committed by Joey Perrott
parent 416403fc63
commit 223b80cb7d
1 changed files with 8 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
packages/common/http/src/client.ts
View File

@ -2526,8 +2526,8 @@ export class HttpClient {
}): Observable<HttpResponse<Object>>;
/**
* Constructs a `PUT` request that interprets the body as a JSON object and returns the full HTTP
* response.
* Constructs a `PUT` request that interprets the body as an instance of the requested type and
* returns the full HTTP response.
*
* @param url The endpoint URL.
* @param body The resources to add/update.
@ -2545,14 +2545,14 @@ export class HttpClient {
}): Observable<HttpResponse<T>>;
/**
* Constructs a `PUT` request that interprets the body as a JSON object and returns the response
* body as a JSON object.
* Constructs a `PUT` request that interprets the body as a JSON object
* and returns an observable of JSON object.
*
* @param url The endpoint URL.
* @param body The resources to add/update.
* @param options HTTP options
*
* @return An `Observable` of the response, with the response body as a JSON object.
* @return An `Observable` of the response as a JSON object.
*/
put(url: string, body: any|null, options?: {
headers?: HttpHeaders|{[header: string]: string | string[]},
@ -2564,15 +2564,14 @@ export class HttpClient {
}): Observable<Object>;
/**
* Constructs a `PUT` request that interprets the body as a JSON object
* and returns an observable of the response.
* Constructs a `PUT` request that interprets the body as an instance of the requested type
* and returns an observable of the requested type.
*
* @param url The endpoint URL.
* @param body The resources to add/update.
* @param options HTTP options
*
* @return An `Observable` of the `HTTPResponse` for the request, with a response body in the
* requested type.
* @return An `Observable` of the requested type.
*/
put<T>(url: string, body: any|null, options?: {
headers?: HttpHeaders|{[header: string]: string | string[]},