on-finished
Execute a callback when a request closes, finishes, or errors.
Install
$ npm install on-finished
API
var onFinished = require('on-finished')
onFinished(res, listener)
Attach a listener to listen for the response to finish. The listener will
be invoked only once when the response finished. If the response finished
to to an error, the first argument will contain the error. If the response
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)
.
onFinished(res, function (err, res) {
})
onFinished(req, listener)
Attach a listener to listen for the request to finish. The listener will
be invoked only once when the request finished. If the request finished
to to an error, the first argument will contain the error. If the request
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)
.
var data = ''
req.setEncoding('utf8')
res.on('data', function (str) {
data += str
})
onFinished(req, function (err, req) {
})
onFinished.isFinished(res)
Determine if res
is already finished. This would be useful to check and
not even start certain operations if the response has already finished.
onFinished.isFinished(req)
Determine if req
is already finished. This would be useful to check and
not even start certain operations if the request has already finished.
Example
The following code ensures that file descriptors are always closed
once the response finishes.
var destroy = require('destroy')
var http = require('http')
var onFinished = require('on-finished')
http.createServer(function onRequest(req, res) {
var stream = fs.createReadStream('package.json')
stream.pipe(res)
onFinished(res, function (err) {
destroy(stream)
})
})
License
MIT