Add message object to callback arguments

closes #11

HISTORY.md

@@ -1,3 +1,8 @@
+unreleased
+==========
+
+  * Add message object to callback arguments
+
 2.1.1 / 2014-10-22
 ==================
 

README.md

@@ -30,9 +30,12 @@ has already finished, the listener will be invoked.
 Listening to the end of a response would be used to close things associated
 with the response, like open files.
 
+Listener is invoked as `listener(err, res)`.
+
 ```js
-onFinished(res, function (err) {
+onFinished(res, function (err, res) {
   // clean up open fds, etc.
+  // err contains the error is request error'd
 })
 ```
 
@@ -46,6 +49,8 @@ has already finished, the listener will be invoked.
 Listening to the end of a request would be used to know when to continue
 after reading the data.
 
+Listener is invoked as `listener(err, req)`.
+
 ```js
 var data = ''
 
@@ -54,7 +59,7 @@ res.on('data', function (str) {
   data += str
 })
 
-onFinished(req, function (err) {
+onFinished(req, function (err, req) {
   // data is read unless there is err
 })
 ```

index.js

@@ -39,7 +39,7 @@ var defer = typeof setImmediate === 'function'
 
 function onFinished(msg, listener) {
   if (isFinished(msg) !== false) {
-    defer(listener)
+    defer(listener, null, msg)
     return msg
   }
 
@@ -161,7 +161,7 @@ function createListener(msg) {
     listener.queue = null
 
     for (var i = 0; i < queue.length; i++) {
-      queue[i](err)
+      queue[i](err, msg)
     }
   }
 

test/test.js

@@ -5,7 +5,7 @@ var net = require('net')
 var onFinished = require('..')
 
 describe('onFinished(res, listener)', function () {
-  it('should invoke listener given an unknwon object', function (done) {
+  it('should invoke listener given an unknown object', function (done) {
     onFinished({}, done)
   })
 
@@ -19,6 +19,19 @@ describe('onFinished(res, listener)', function () {
       sendget(server)
     })
 
+    it('should include the response object', function (done) {
+      var server = http.createServer(function (req, res) {
+        onFinished(res, function (err, msg) {
+          assert.ok(!err)
+          assert.equal(msg, res)
+          done()
+        })
+        setTimeout(res.end.bind(res), 0)
+      })
+
+      sendget(server)
+    })
+
     it('should fire when called after finish', function (done) {
       var server = http.createServer(function (req, res) {
         onFinished(res, function () {
@@ -137,6 +150,26 @@ describe('onFinished(res, listener)', function () {
         })
       })
     })
+
+    it('should include the response object', function (done) {
+      var server = http.createServer(function (req, res) {
+        onFinished(res, function (err, msg) {
+          assert.ok(err)
+          assert.equal(msg, res)
+          done()
+        })
+
+        socket.on('error', noop)
+        socket.write('W')
+      })
+      var socket
+
+      server.listen(function () {
+        socket = net.connect(this.address().port, function () {
+          writerequest(this, true)
+        })
+      })
+    })
   })
 
   describe('when the response aborts', function () {
@@ -338,6 +371,20 @@ describe('onFinished(req, listener)', function () {
       sendget(server)
     })
 
+    it('should include the request objecy', function (done) {
+      var server = http.createServer(function (req, res) {
+        onFinished(req, function (err, msg) {
+          assert.ok(!err)
+          assert.equal(msg, req)
+          done()
+        })
+        req.resume()
+        setTimeout(res.end.bind(res), 0)
+      })
+
+      sendget(server)
+    })
+
     it('should fire when called after finish', function (done) {
       var server = http.createServer(function (req, res) {
         onFinished(req, function () {
@@ -411,6 +458,26 @@ describe('onFinished(req, listener)', function () {
         })
       })
     })
+
+    it('should include the request objecy', function (done) {
+      var server = http.createServer(function (req, res) {
+        onFinished(req, function (err, msg) {
+          assert.ok(err)
+          assert.equal(msg, req)
+          done()
+        })
+
+        socket.on('error', noop)
+        socket.write('W')
+      })
+      var socket
+
+      server.listen(function () {
+        socket = net.connect(this.address().port, function () {
+          writerequest(this, true)
+        })
+      })
+    })
   })
 
   describe('when the request aborts', function () {