on-finished
Advanced tools
Package description
The on-finished npm package is a utility to execute a callback when an HTTP request/response cycle is completed or finished. It is useful for logging, cleaning up resources, or performing actions after the response has been sent to the client.
Execute callback when response finishes
This code sample creates an HTTP server that listens on port 3000. For each request, it uses on-finished to execute a callback when the response is finished. The callback logs 'Response finished' to the console.
const onFinished = require('on-finished');
const http = require('http');
http.createServer((req, res) => {
onFinished(res, (err, res) => {
console.log('Response finished');
});
res.end('Hello World');
}).listen(3000);Detect when request is closed by the client
This code sample demonstrates how to use on-finished to detect when an HTTP request is closed prematurely by the client, such as when the client navigates away from the page or cancels the request.
const onFinished = require('on-finished');
const http = require('http');
http.createServer((req, res) => {
onFinished(req, (err, req) => {
if (err && err.code === 'ECONNRESET') {
console.log('Request closed by the client');
}
});
res.end('Hello World');
}).listen(3000);The finalhandler package is similar to on-finished in that it is designed to ensure that the final callback is executed once the response is completed. It differs in that it is specifically designed to be used as the final step in a middleware chain and includes additional features like error handling.
The ee-first package is a lower-level utility for ordering multiple event emitters. While it does not directly provide the same functionality as on-finished, it can be used to achieve similar results by tracking the 'end' or 'finish' events of streams, including HTTP request and response objects.
Readme
Execute a callback when a request closes, finishes, or errors.
$ npm install on-finished
var onFinished = require('on-finished')
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.
Listening to the end of a response would be used to close things associated with the response, like open files.
onFinished(res, function (err) {
// clean up open fds, etc.
})
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.
Listening to the end of a request would be used to know when to continue after reading the data.
var data = ''
req.setEncoding('utf8')
res.on('data', function (str) {
data += str
})
onFinished(req, function (err) {
// data is read unless there is err
})
Determine if res is already finished. This would be useful to check and
not even start certain operations if the response has already finished.
Determine if req is already finished. This would be useful to check and
not even start certain operations if the request has already finished.
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('finished')
http.createServer(function onRequest(req, res) {
var stream = fs.createReadStream('package.json')
stream.pipe(res)
onFinished(res, function (err) {
destroy(stream)
})
})
FAQs
Execute a callback when a request closes, finishes, or errors
The npm package on-finished receives a total of 30,069,728 weekly downloads. As such, on-finished popularity was classified as popular.
We found that on-finished demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
This episode of the Risky Biz podcast discusses how the rise of small open source packages and the shift towards individual maintainers makes the ecosystem more vulnerable to supply chain attacks.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.