Merge pull request #21 from leandrohlsilva/feature/response

Return response as third parameter if handler is set

Author: antony

lib/index.js

@@ -229,8 +229,8 @@ class Api {
       this.resetRequest()
     }
 
-    const { json, httpStatus } = result
-    return fn ? fn(json, httpStatus) : json
+    const { json, httpStatus, response } = result
+    return fn ? fn(json, httpStatus, response) : json
   }
 
   /**
@@ -277,7 +277,7 @@ class Api {
           }
         }
 
-        return { httpStatus: r.status, json }
+        return { httpStatus: r.status, json, response: r }
       }
 
       let content = ''

lib/index.spec.js

@@ -281,6 +281,26 @@ describe('util/api', () => {
         expect(code).to.equal(httpStatusCode)
       })
 
+      it('passes the whole response as third parameter', async () => {
+
+        const stubbedResponse = {
+          status: 202,
+          json: stub().resolves({ foo: 'bar' }),
+          statusText: 'Accepted',
+          headers: new Map([ ['john', 'doe'] ])
+        }
+        clientStub.resolves(stubbedResponse)
+
+        const response = await api
+          .context({ fetch: clientStub })
+          .endpoint('some/url')
+          .get((json, statusCode, response) => {
+            return response
+          })
+
+        expect(response.headers).to.equal(stubbedResponse.headers)
+      })
+
       it('parses 3xx as successful', async () => {
         const httpStatusCode = 304
 
@@ -598,7 +618,7 @@ describe('util/api', () => {
         })
 
         it('has cleared method', () => {
-          expect(api.config.method).to.equal('get')
+          expect(api.config.method).to.equal('GET')
         })
 
         it('has not cleared client', () => {

lib/types.ts

@@ -82,7 +82,7 @@ export type ErrorHandlers = {
 /**
  * Function to transform API response
  */
-export type ResponseTransformer<T = any> = (json: any, httpStatus: number) => T;
+export type ResponseTransformer<T = any> = (json: any, httpStatus: number, response: Response) => T;
 
 /**
  * Fetch client interface
@@ -110,4 +110,5 @@ export type Response = {
 export type QueryResult = {
   httpStatus: number;
   json?: any;
+  response: Response;
 };