iSharkFly-Docs
/
angular-docs-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix(common): add body as an optional property on the options of HttpClient.delete (#19438) (#41723) 

adding optional body for HTTP delete request options. This new param added as an optional so won't break the existing code also provide the capability the send the body when and where it required.

PR Close #41723
This commit is contained in:
Gopal Jayaraman 2021-04-20 18:14:06 +05:30 committed by Misko Hevery
parent 19b12d7286
commit 6b8baad940
3 changed files with 55 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
goldens/public-api/common/http/http.d.ts vendored
View File

@ -18,6 +18,7 @@ export declare class HttpClient {
reportProgress?: boolean;
responseType: 'arraybuffer';
withCredentials?: boolean;
body?: any | null;
}): Observable<ArrayBuffer>;
delete(url: string, options: {
headers?: HttpHeaders | {
@ -31,6 +32,7 @@ export declare class HttpClient {
reportProgress?: boolean;
responseType: 'blob';
withCredentials?: boolean;
body?: any | null;
}): Observable<Blob>;
delete(url: string, options: {
headers?: HttpHeaders | {
@ -44,6 +46,7 @@ export declare class HttpClient {
reportProgress?: boolean;
responseType: 'text';
withCredentials?: boolean;
body?: any | null;
}): Observable<string>;
delete(url: string, options: {
headers?: HttpHeaders | {
@ -57,6 +60,7 @@ export declare class HttpClient {
reportProgress?: boolean;
responseType: 'arraybuffer';
withCredentials?: boolean;
body?: any | null;
}): Observable<HttpEvent<ArrayBuffer>>;
delete(url: string, options: {
headers?: HttpHeaders | {
@ -70,6 +74,7 @@ export declare class HttpClient {
reportProgress?: boolean;
responseType: 'blob';
withCredentials?: boolean;
body?: any | null;
}): Observable<HttpEvent<Blob>>;
delete(url: string, options: {
headers?: HttpHeaders | {
@ -83,6 +88,7 @@ export declare class HttpClient {
reportProgress?: boolean;
responseType: 'text';
withCredentials?: boolean;
body?: any | null;
}): Observable<HttpEvent<string>>;
delete(url: string, options: {
headers?: HttpHeaders | {
@ -96,6 +102,7 @@ export declare class HttpClient {
reportProgress?: boolean;
responseType?: 'json';
withCredentials?: boolean;
body?: any | null;
}): Observable<HttpEvent<Object>>;
delete<T>(url: string, options: {
headers?: HttpHeaders | {
@ -109,6 +116,7 @@ export declare class HttpClient {
reportProgress?: boolean;
responseType?: 'json';
withCredentials?: boolean;
body?: any | null;
}): Observable<HttpEvent<T>>;
delete(url: string, options: {
headers?: HttpHeaders | {
@ -122,6 +130,7 @@ export declare class HttpClient {
reportProgress?: boolean;
responseType: 'arraybuffer';
withCredentials?: boolean;
body?: any | null;
}): Observable<HttpResponse<ArrayBuffer>>;
delete(url: string, options: {
headers?: HttpHeaders | {
@ -135,6 +144,7 @@ export declare class HttpClient {
reportProgress?: boolean;
responseType: 'blob';
withCredentials?: boolean;
body?: any | null;
}): Observable<HttpResponse<Blob>>;
delete(url: string, options: {
headers?: HttpHeaders | {
@ -148,6 +158,7 @@ export declare class HttpClient {
reportProgress?: boolean;
responseType: 'text';
withCredentials?: boolean;
body?: any | null;
}): Observable<HttpResponse<string>>;
delete(url: string, options: {
headers?: HttpHeaders | {
@ -161,6 +172,7 @@ export declare class HttpClient {
reportProgress?: boolean;
responseType?: 'json';
withCredentials?: boolean;
body?: any | null;
}): Observable<HttpResponse<Object>>;
delete<T>(url: string, options: {
headers?: HttpHeaders | {
@ -174,6 +186,7 @@ export declare class HttpClient {
reportProgress?: boolean;
responseType?: 'json';
withCredentials?: boolean;
body?: any | null;
}): Observable<HttpResponse<T>>;
delete(url: string, options?: {
headers?: HttpHeaders | {
@ -187,6 +200,7 @@ export declare class HttpClient {
reportProgress?: boolean;
responseType?: 'json';
withCredentials?: boolean;
body?: any | null;
}): Observable<Object>;
delete<T>(url: string, options?: {
headers?: HttpHeaders | {
@ -200,6 +214,7 @@ export declare class HttpClient {
reportProgress?: boolean;
responseType?: 'json';
withCredentials?: boolean;
body?: any | null;
}): Observable<T>;
get(url: string, options: {
headers?: HttpHeaders | {

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

@ -619,6 +619,7 @@ export class HttpClient {
{[param: string]: string | number | boolean | ReadonlyArray<string|number|boolean>},
reportProgress?: boolean, responseType: 'arraybuffer',
withCredentials?: boolean,
body?: any|null,
}): Observable<ArrayBuffer>;
@ -639,6 +640,7 @@ export class HttpClient {
{[param: string]: string | number | boolean | ReadonlyArray<string|number|boolean>},
reportProgress?: boolean, responseType: 'blob',
withCredentials?: boolean,
body?: any|null,
}): Observable<Blob>;
/**
@ -658,6 +660,7 @@ export class HttpClient {
{[param: string]: string | number | boolean | ReadonlyArray<string|number|boolean>},
reportProgress?: boolean, responseType: 'text',
withCredentials?: boolean,
body?: any|null,
}): Observable<string>;
/**
@ -677,6 +680,7 @@ export class HttpClient {
{[param: string]: string | number | boolean | ReadonlyArray<string|number|boolean>},
reportProgress?: boolean, responseType: 'arraybuffer',
withCredentials?: boolean,
body?: any|null
}): Observable<HttpEvent<ArrayBuffer>>;
/**
@ -696,6 +700,7 @@ export class HttpClient {
{[param: string]: string | number | boolean | ReadonlyArray<string|number|boolean>},
reportProgress?: boolean, responseType: 'blob',
withCredentials?: boolean,
body?: any|null,
}): Observable<HttpEvent<Blob>>;
/**
@ -715,6 +720,7 @@ export class HttpClient {
{[param: string]: string | number | boolean | ReadonlyArray<string|number|boolean>},
reportProgress?: boolean, responseType: 'text',
withCredentials?: boolean,
body?: any|null,
}): Observable<HttpEvent<string>>;
/**
@ -735,6 +741,7 @@ export class HttpClient {
reportProgress?: boolean,
responseType?: 'json',
withCredentials?: boolean,
body?: any|null,
}): Observable<HttpEvent<Object>>;
/**
@ -755,6 +762,7 @@ export class HttpClient {
reportProgress?: boolean,
responseType?: 'json',
withCredentials?: boolean,
body?: any|null,
}): Observable<HttpEvent<T>>;
/**
@ -773,6 +781,7 @@ export class HttpClient {
{[param: string]: string | number | boolean | ReadonlyArray<string|number|boolean>},
reportProgress?: boolean, responseType: 'arraybuffer',
withCredentials?: boolean,
body?: any|null,
}): Observable<HttpResponse<ArrayBuffer>>;
/**
@ -791,6 +800,7 @@ export class HttpClient {
{[param: string]: string | number | boolean | ReadonlyArray<string|number|boolean>},
reportProgress?: boolean, responseType: 'blob',
withCredentials?: boolean,
body?: any|null,
}): Observable<HttpResponse<Blob>>;
/**
@ -809,6 +819,7 @@ export class HttpClient {
{[param: string]: string | number | boolean | ReadonlyArray<string|number|boolean>},
reportProgress?: boolean, responseType: 'text',
withCredentials?: boolean,
body?: any|null,
}): Observable<HttpResponse<string>>;
/**
@ -829,6 +840,7 @@ export class HttpClient {
reportProgress?: boolean,
responseType?: 'json',
withCredentials?: boolean,
body?: any|null,
}): Observable<HttpResponse<Object>>;
/**
@ -848,6 +860,7 @@ export class HttpClient {
reportProgress?: boolean,
responseType?: 'json',
withCredentials?: boolean,
body?: any|null,
}): Observable<HttpResponse<T>>;
/**
@ -868,6 +881,7 @@ export class HttpClient {
reportProgress?: boolean,
responseType?: 'json',
withCredentials?: boolean,
body?: any|null,
}): Observable<Object>;
/**
@ -888,6 +902,7 @@ export class HttpClient {
reportProgress?: boolean,
responseType?: 'json',
withCredentials?: boolean,
body?: any|null,
}): Observable<T>;
/**
@ -908,6 +923,7 @@ export class HttpClient {
reportProgress?: boolean,
responseType?: 'arraybuffer'|'blob'|'json'|'text',
withCredentials?: boolean,
body?: any|null,
} = {}): Observable<any> {
return this.request<any>('DELETE', url, options as any);
}

24
packages/common/http/test/client_spec.ts
View File

@ -177,6 +177,30 @@ import {toArray} from 'rxjs/operators';
testReq.flush('hello world');
});
});
describe('makes a DELETE request', () => {
it('with body', done => {
const body = {data: 'json body'};
client.delete('/test', {observe: 'response', responseType: 'text', body: body})
.subscribe(res => {
expect(res.ok).toBeTruthy();
expect(res.status).toBe(200);
done();
});
const testReq = backend.expectOne('/test');
expect(testReq.request.body).toBe(body);
testReq.flush('hello world');
});
it('without body', done => {
client.delete('/test', {observe: 'response', responseType: 'text'}).subscribe(res => {
expect(res.ok).toBeTruthy();
expect(res.status).toBe(200);
done();
});
const testReq = backend.expectOne('/test');
expect(testReq.request.body).toBe(null);
testReq.flush('hello world');
});
});
describe('makes a JSONP request', () => {
it('with properly set method and callback', done => {
client.jsonp('/test', 'myCallback').subscribe(() => done());