koa-etag

koa-etag

Etag support for Koa responses using etag.

Please use @koa/etag (v5+) instead. It is the same module, and this package will be deprecated in the next major release.

Installation

# npm
$ npm install koa-etag
# yarn
$ yarn add koa-etag

Example

const Koa = require('koa');
const etag = require('koa-etag');
const conditional = require('koa-conditional-get');
const compress = require('koa-compress');

const app = new Koa();

// must be used before `conditional` and `etag`
app.use(compress());

// etag works together with conditional-get
app.use(conditional());
app.use(etag());

app.use(function (ctx) {
  ctx.body = 'Hello World';
});

app.listen(3000);

console.log('listening on port 3000');

License

MIT

Similar packages

Other packages similar to koa-etag

etag

The etag package is a standalone utility for generating ETag HTTP headers. Unlike koa-etag, it is not specific to Koa and can be used with any Node.js HTTP server. It provides more granular control over ETag generation but requires manual integration.

koa-conditional-get

The koa-conditional-get package is a middleware for Koa that handles conditional GET requests using If-None-Match and If-Modified-Since headers. While it does not generate ETags itself, it works well in combination with koa-etag to provide a complete caching solution.

koa-static

The koa-static package serves static files and includes built-in support for ETag headers. It is more specialized for serving static assets, whereas koa-etag is more general-purpose and can be used with any type of response.