ETag 中间件

使用此中间件，您可以轻松添加 ETag 标头。

导入

import { Hono } from 'hono'
import { etag } from 'hono/etag'

用法

const app = new Hono()

app.use('/etag/*', etag())
app.get('/etag/abc', (c) => {
  return c.text('Hono 很酷')
})

保留的标头

304 响应必须包含在等效的 200 OK 响应中会发送的标头。默认标头是 Cache-Control、Content-Location、Date、ETag、Expires 和 Vary。

如果您想添加要发送的标头，可以使用 retainedHeaders 选项和包含默认标头的 RETAINED_304_HEADERS 字符串数组变量：

import { etag, RETAINED_304_HEADERS } from 'hono/etag'

// ...

app.use(
  '/etag/*',
  etag({
    retainedHeaders: ['x-message', ...RETAINED_304_HEADERS],
  })
)

选项

可选 weak: boolean

定义是否使用弱验证。如果设置为 true，则会将 w/ 添加到值的前缀。默认值为 false。

可选 retainedHeaders: string[]

您希望在 304 响应中保留的标头。

可选 generateDigest: (body: Uint8Array) => ArrayBuffer | Promise<ArrayBuffer>

一个自定义的摘要生成函数。默认情况下，它使用 SHA-1。此函数以 Uint8Array 形式的响应正文作为参数调用，并且应返回一个 ArrayBuffer 或一个 Promise 形式的哈希值。