# @bogeychan/elysia-logger 中文文档

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

版本：0\.1\.10
npm 元数据更新时间：2025-08-08T08:24:39.493Z
中文译文更新时间：2026-11-08T10:07:14.727Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：51.3 kB，15 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：elysia \>= 1\.2\.10，pino \>= 9\.6\.0
- 首次发布：2023-04-21T23:31:04.504Z
- 最新版本发布：2025-08-08T08:24:39.305Z
- 近 30 天下载量：256066（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：37（近 12 个月 0 个）

## 中文简介

Elysia.js 的插件,用于使用 Pino 库进行日志

## 安装

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

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

## README

# @bogeychan/elysia-logger (英语)

用于 [艾丽西亚.js](https://elysiajs.com/) 使用 [皮诺](https://getpino.io/) 图书馆.

## [移徙指南](https://npmcn.com/package/%40bogeychan/elysia-logger/MIGRATION.md)

## 安装

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

## 使用量

```ts
import { Elysia } from "elysia";
import { logger } from "@bogeychan/elysia-logger";

const app = new Elysia()
  .use(
    logger({
      level: "error",
    })
  )
  .get("/", (ctx) => {
    ctx.log.error(ctx, "Context");
    ctx.log.info(ctx.request, "Request"); // noop

    return "Hello World";
  })
  .listen(3000);

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

### 日志为文件,或

```ts
import { fileLogger } from "@bogeychan/elysia-logger";

fileLogger({
  file: "./my.log",
});
```

### 将日志条目插入流中

```ts
import { logger } from '@bogeychan/elysia-logger';

logger({
  stream: ... // default -> console output
});
```

### 包含请求上下文信息

```ts
import { logger, type InferContext } from "@bogeychan/elysia-logger";

const myPlugin = () => new Elysia().decorate("myProperty", 42);

// ...

class MyError extends Error {
  constructor(message: string, public myValue: string) {
    super(message);
  }
}

app = app.error("myError", MyError).use(myPlugin());

app
  .use(
    logger({
      /**
       * This function will be invoked for each `log`-method called
       * where you can pass additional properties that need to be logged
       */
      customProps(ctx: InferContext<typeof app>) {
        if (ctx.isError && ctx.code === "myError") {
          return {
            myValue: ctx.error.myValue,
          };
        }

        return {
          params: ctx.params,
          query: ctx.query,
          myProperty: ctx.myProperty,
        };
      },
    })
  )
  .get("/", (ctx) => {
    ctx.log.info(ctx, "Context");

    return "with-context";
  })
  .get("/error", () => {
    throw new MyError("whelp", "yay");
  });
```

### 双双使用日志实例 `Standalone` 内部 `Context`

```ts
import { createPinoLogger } from "@bogeychan/elysia-logger";

const log = createPinoLogger(/* ... */);

app
  .use(log.into(/* ... */))
  .onError((ctx) => {
    log.error(ctx, ctx.error.name);
    return "onError";
  })
  .get("/", (ctx) => {
    ctx.log.info(ctx, "Context");

    throw new Error("whelp");
  });
```

### 使用现有的 `pino` 日志

```ts
import { pino } from "pino";
import { wrap } from "@bogeychan/elysia-logger";

const logger = pino(/* ... */);

app
  .use(
    wrap(logger, {
      /* ... */
    })
  )
  .get("/", (ctx) => {
    ctx.log.info(ctx, "Context");

    return "wrapped!";
  });
```

### 自动 `onAfterResponse` 打开 `onError` 登录方式 `default`; 基于 [皮诺-http](https://github.com/pinojs/pino-http)

```ts
import { logger } from "@bogeychan/elysia-logger";

app
  .use(
    logger({
      autoLogging: true, // default
      autoLogging: false, // disabled
      autoLogging: {
        ignore(ctx) {
          return true; // ignore logging for requests based on condition
        },
      },
    })
  )
  .get("/", (ctx) => "autoLogging");
```

检查 [实例](https://npmcn.com/package/%40bogeychan/elysia-logger/examples) github 文件夹,供进一步使用,例如整合 [皮诺色](https://github.com/pinojs/pino-pretty) 可读控制台输出.

## 许可证

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

## 常见问题

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

Elysia\.js 的插件,用于使用 Pino 库进行日志

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

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

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

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

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

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

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

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

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

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

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

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