feat(response): add few more properties

thetutlage · thetutlage · commit 46930ebf00a9 · 2016-08-20T02:14:58.000+05:30
add getters for response.{finished, headersSent, isPending}
diff --git a/src/Response/index.js b/src/Response/index.js
@@ -32,6 +32,42 @@ class Response {
     })
   }
 
+  /**
+   * returns whether request has been
+   * finished or not
+   *
+   * @method finished
+   *
+   * @return {Boolean}
+   */
+  get finished () {
+    return this.response.finished
+  }
+
+  /**
+   * returns whether request headers
+   * have been sent or not
+   *
+   * @method headersSent
+   *
+   * @return {Boolean}
+   */
+  get headersSent () {
+    return this.response.headersSent
+  }
+
+  /**
+   * returns whether a request is pending
+   * or not
+   *
+   * @method isPending
+   *
+   * @return {Boolean}
+   */
+  get isPending () {
+    return (!this.headersSent && !this.finished)
+  }
+
   /**
    * sets key/value pair on response header
    *
diff --git a/test/unit/response.spec.js b/test/unit/response.spec.js
@@ -365,4 +365,40 @@ describe('Response', function () {
     const response = new Response({name: 'bar'}, {setHeader: function () {}})
     expect(response.foo()).to.equal('bar')
   })
+
+  it('should return true for isPending when request has not been ended', function * () {
+    const server = http.createServer((req, res) => {
+      const request = new Request(req, res, Config)
+      const Response = new ResponseBuilder({}, Route, Config)
+      const response = new Response(request, res)
+      const isPending = response.isPending
+      response.send({isPending})
+    })
+    const res = yield supertest(server).get('/').expect(200).end()
+    expect(res.body.isPending).to.equal(true)
+  })
+
+  it('should return false for finished when request has not been ended', function * () {
+    const server = http.createServer((req, res) => {
+      const request = new Request(req, res, Config)
+      const Response = new ResponseBuilder({}, Route, Config)
+      const response = new Response(request, res)
+      const finished = response.finished
+      response.send({finished})
+    })
+    const res = yield supertest(server).get('/').expect(200).end()
+    expect(res.body.finished).to.equal(false)
+  })
+
+  it('should return false for headersSent when request has not been ended', function * () {
+    const server = http.createServer((req, res) => {
+      const request = new Request(req, res, Config)
+      const Response = new ResponseBuilder({}, Route, Config)
+      const response = new Response(request, res)
+      const headersSent = response.headersSent
+      response.send({headersSent})
+    })
+    const res = yield supertest(server).get('/').expect(200).end()
+    expect(res.body.headersSent).to.equal(false)
+  })
 })
