@otterhttp/etag

A rewrite of etag module.

This module generates HTTP ETags (as defined in RFC 7232) for use in HTTP responses.

Install

pnpm i @otterhttp/etag

API

import { eTag } from '@otterhttp/etag'

eTag(entity, [options])

Generate a strong ETag for the given entity. This should be the complete body of the entity. Strings, Buffers, and fs.Stats are accepted. By default, a strong ETag is generated except for fs.Stats, which will generate a weak ETag (this can be overwritten by options.weak).

res.setHeader('ETag', eTag(body))

Options

eTag accepts these properties in the options object.

weak

Specifies if the generated ETag will include the weak validator mark (that is, the leading W/). The actual entity tag is the same. The default value is false, unless the entity is fs.Stats, in which case it is true.