# @bogeychan/elysia-etag 中文文档

规范地址：https://npmcn.com/package/%40bogeychan/elysia-etag/

版本：0\.1\.0
npm 元数据更新时间：2025-01-26T23:25:36.014Z
中文译文更新时间：2026-11-08T11:23:12.883Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40bogeychan/elysia-etag
原文对照：https://npmcn.com/package/%40bogeychan/elysia-etag/?lang=original
项目主页：https://github.com/bogeychan/elysia-etag
源码仓库：https://github.com/bogeychan/elysia-etag

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：16.7 kB，14 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：elysia \>= 1\.2\.10
- 首次发布：2023-09-09T22:39:14.363Z
- 最新版本发布：2025-01-26T23:25:35.817Z
- 近 30 天下载量：1790（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：7（近 12 个月 0 个）

## 中文简介

Elysia.js 自动 HTTP ETag 生成的插件

## 安装

```sh
npm install @bogeychan/elysia-etag
```

也可以使用：`pnpm add @bogeychan/elysia-etag`、`yarn add @bogeychan/elysia-etag`、`bun add @bogeychan/elysia-etag`

## README

# @bogeychan/elysia-etag (英语)

用于 [艾丽西亚.js](https://elysiajs.com/) 用于自动 [HTTP ETAG 软件](https://http.dev/etag) 生成

## 安装

```bash
bun add @bogeychan/elysia-etag
```

## 使用量

```ts
import { Elysia } from 'elysia'
import { etag } from '@bogeychan/elysia-etag'

const app = new Elysia()
    .use(etag())
    .get('/', () => 'Checkout the response headers!')
    .get('/custom-etag', (ctx) => {
        // This line disables automatic ETag generation
        // It will still return a 304 - Not Modified - status code if the ETag matches
        ctx.setETag('"myETag"')
        return 'Hello ETag!'
    })
    .listen(3000)

console.log(`Listening on ${app.server!.url}`)
```

### 使用 `serialize` 将不兼容数据转换为可散列格式

#### 带着JSON

```ts
new Elysia()
    .use(
        etag({
            serialize(response) {
                if (typeof response === 'object') {
                    return JSON.stringify(response)
                }
            }
        })
    )
    .get('/', () => ({ my: 'json' }))
```

#### 与 [包单](https://bun.sh/docs/api/file-io)

```ts
new Elysia()
    .use(
        etag({
            serialize(response) {
                if (response instanceof Blob && 'lastModified' in response) {
                    // based on last modified UNIX timestamp
                    return (response as BunFile).lastModified.toString()

                    // based on file content
                    return (response as BunFile).bytes()
                }
            }
        })
    )
    .get('/', () => Bun.file('./file.txt'))
```

### 自己提供 `hash` 函数

```ts
let myInsecureChangeCounter = 0

new Elysia()
    .use(
        etag({
            hash: (response) => {
                return (response as string) + myInsecureChangeCounter++
            }
        })
    )
    .get('/', () => 'Checkout the response headers!')
```

检查 [实例](https://npmcn.com/package/%40bogeychan/elysia-etag/examples) 用于进一步使用的 github 文件夹.

## 功劳

这个项目的灵感来自 [@ fastify/ etag](https://www.npmjs.com/package/@fastify/etag)

## 作者

[宝洁](https://github.com/bogeychan)

## 许可证

[麻省理工学院](https://npmcn.com/package/%40bogeychan/elysia-etag/LICENSE)

## 常见问题

### @bogeychan/elysia-etag 是什么？

Elysia\.js 自动 HTTP ETag 生成的插件

### 如何安装 @bogeychan/elysia-etag？

在项目目录运行 npm install @bogeychan/elysia-etag，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：elysia（\>= 1\.2\.10）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @bogeychan/elysia-etag 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @bogeychan/elysia-etag 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @bogeychan/elysia-etag 可以商用吗？

@bogeychan/elysia-etag 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @bogeychan/elysia-etag 的下载量有多少？

根据 npm 官方下载统计，@bogeychan/elysia-etag 在 2026/10/09 – 2026/11/07 这 30 天内被下载 1,790 次，日均约 60 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @bogeychan/elysia-etag 还在维护吗？

最新版本 0\.1\.0 发布于 2025/01/27（1\.8 年前）；至今共发布 7 个版本，其中过去 12 个月发布了 0 个；首次发布于 2023/09/10。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。