Add custom options object to HttpClient methods

Author: DrewImm

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## [3.3.0] Nov-13-2019
 
 ### Additions
+- Add custom options object to HttpClient methods
 - Add npm keywords
 - [Issue #192] HttpClient must allow for custom headers
 

src/http/http-client.ts

@@ -33,15 +33,17 @@ export class HttpClient {
 	 * @param data Data to send as query
 	 * @param bearer Bearer token to send
 	 * @param expect Array of status codes to expect
+	 * @param customOptions Additional request options
 	 * @return Returns a promise of HttpClientResponse
 	 */
 	public post(
 		path: string,
 		data: object,
 		bearer: boolean | string = false,
-		expect: number[] = [ 200, 201, 202, 204 ]
+		expect: number[] = [ 200, 201, 202, 204 ],
+		customOptions?: object
 	): Promise<HttpClientResponse> {
-		const options = {
+		let options = {
 			method: 'POST',
 			url: `${this.url}:${this.port}${path}`,
 			body: data,
@@ -56,6 +58,10 @@ export class HttpClient {
 			options['headers'] = this.headers;
 		}
 
+		if (customOptions) {
+			options = Object.assign(options, options);
+		}
+
 		return new Promise<HttpClientResponse>((accept, reject) => {
 			this.request(options, (error, response, body) => {
 				if (error) {
@@ -82,16 +88,18 @@ export class HttpClient {
 	 * @param data Data to send as query
 	 * @param bearer Bearer token to send
 	 * @param expect Array of status codes to expect
+	 * @param customOptions Additional request options
 	 * @return Returns a promise of HttpClientResponse
 	 */
 	public get(
 		path: string,
 		data: boolean | Object = false,
 		bearer: boolean | string = false,
-		expect: number[] = [ 200, 202 ]
+		expect: number[] = [ 200, 202 ],
+		customOptions?: object
 	): Promise<HttpClientResponse> {
 		return new Promise<HttpClientResponse>((accept, reject) => {
-			const options = {
+			let options = {
 				method: 'GET',
 				url: `${this.url}:${this.port}${path}`,
 				json: true,
@@ -106,6 +114,10 @@ export class HttpClient {
 				options['headers'] = this.headers;
 			}
 
+			if (customOptions) {
+				options = Object.assign(options, options);
+			}
+
 			this.request(options, (error, response, body) => {
 				if (error) {
 					reject(new HttpClientResponse(response, error));
@@ -131,15 +143,17 @@ export class HttpClient {
 	 * @param data Data to send as query
 	 * @param bearer Bearer token to send
 	 * @param expect Array of status codes to expect
+	 * @param customOptions Additional request options
 	 * @return Returns a promise of HttpClientResponse
 	 */
 	public patch(
 		path: string,
 		data: object,
 		bearer: boolean | string = false,
-		expect: number[] = [ 200, 201, 202, 204 ]
+		expect: number[] = [ 200, 201, 202, 204 ],
+		customOptions?: object
 	): Promise<HttpClientResponse> {
-		const options = {
+		let options = {
 			method: 'PATCH',
 			url: `${this.url}:${this.port}${path}`,
 			body: data,
@@ -154,6 +168,10 @@ export class HttpClient {
 			options['headers'] = this.headers;
 		}
 
+		if (customOptions) {
+			options = Object.assign(options, options);
+		}
+
 		return new Promise<HttpClientResponse>((accept, reject) => {
 			this.request(options, (error, response, body) => {
 				if (error) {
@@ -180,15 +198,17 @@ export class HttpClient {
 	 * @param data Data to send as query
 	 * @param bearer Bearer token to send
 	 * @param expect Array of status codes to expect
+	 * @param customOptions Additional request options
 	 * @return Returns a promise of HttpClientResponse
 	 */
 	public delete(
 		path: string,
 		bearer: boolean | string = false,
-		expect: number[] = [ 200, 202, 204 ]
+		expect: number[] = [ 200, 202, 204 ],
+		customOptions?: object
 	): Promise<HttpClientResponse> {
 		return new Promise<HttpClientResponse>((accept, reject) => {
-			const options = {
+			let options = {
 				method: 'DELETE',
 				url: `${this.url}:${this.port}${path}`
 			};
@@ -201,6 +221,10 @@ export class HttpClient {
 				options['headers'] = this.headers;
 			}
 
+			if (customOptions) {
+				options = Object.assign(options, options);
+			}
+
 			this.request(options, (error, response, body) => {
 				if (error) {
 					reject(new HttpClientResponse(response, error));

test/spec/api/http/http-client.spec.ts

@@ -29,7 +29,7 @@ describe('[HTTP] HTTP Client', () => {
 
 	it('can get', async () => {
 		const result: void | HttpClientResponse = await http
-			.get('/', {}, 'Bearer: test', [ 404 ])
+			.get('/', {}, 'Bearer: test', [ 404 ], {})
 			.catch((error) => fail(JSON.stringify(error)));
 
 		if (result) {
@@ -52,7 +52,7 @@ describe('[HTTP] HTTP Client', () => {
 
 	it('can post', async () => {
 		const result: void | HttpClientResponse = await http
-			.post('/', {}, 'Bearer: test', [ 404 ])
+			.post('/', {}, 'Bearer: test', [ 404 ], {})
 			.catch((error) => fail(JSON.stringify(error)));
 
 		if (result) {
@@ -75,7 +75,7 @@ describe('[HTTP] HTTP Client', () => {
 
 	it('can patch', async () => {
 		const result: void | HttpClientResponse = await http
-			.patch('/', {}, 'Bearer: test', [ 404 ])
+			.patch('/', {}, 'Bearer: test', [ 404 ], {})
 			.catch((error) => fail(JSON.stringify(error)));
 
 		if (result) {
@@ -98,7 +98,7 @@ describe('[HTTP] HTTP Client', () => {
 
 	it('can delete', async () => {
 		const result: void | HttpClientResponse = await http
-			.delete('/', 'Bearer: test', [ 404 ])
+			.delete('/', 'Bearer: test', [ 404 ], {})
 			.catch((error) => fail(JSON.stringify(error)));
 
 		if (result) {