# @flatfile/utils-debugger 中文文档

规范地址：https://npmcn.com/package/%40flatfile/utils-debugger/

版本：0\.0\.6
npm 元数据更新时间：2026-04-23T23:55:10.409Z
中文译文更新时间：2026-11-14T21:49:59.511Z
软件包许可：ISC

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

原始 npm 页面：https://www.npmjs.com/package/%40flatfile/utils-debugger
原文对照：https://npmcn.com/package/%40flatfile/utils-debugger/?lang=original

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

- 包体积（解压后）：21.1 kB，5 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2023-06-07T02:56:58.008Z
- 最新版本发布：2024-05-02T01:50:10.847Z
- 近 30 天下载量：113140（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：7（近 12 个月 0 个）

## 中文简介

向控制台记录有用消息的助手

## 安装

```sh
npm install @flatfile/utils-debugger
```

也可以使用：`pnpm add @flatfile/utils-debugger`、`yarn add @flatfile/utils-debugger`、`bun add @flatfile/utils-debugger`

## README

# @ flatfile/ utils- 调试器

此软件包是一个工具调试器, 旨在方便对应用程序中的各种事件、 问题和进程进行跟踪、 记录和调试 。 它具有色彩丰富的控制台输出功能,以更好地显示和了解您的系统状况.

## 特征

-   HTTP 请求日志
-   事件订阅记录
-   事件记录
-   记录警告、成功和错误
-   通用伐木

## 使用量

@ flatfile/ utils- debugger 软件包提供了一个 `Debugger` 它暴露了几种静态方法 每一种方法都旨在记录具体类型的事件或问题.

以下是现有方法的概述:

### 对数Http 请求( 段落)

关于HTTP请求的日志细节. 它需要具有下列属性的对象:

-   `method`: HTTP 方法( GET, POST, PUT, DELETE等)
-   `url`: 请求 URL.
-   `statusCode`: HTTP 状态代码.
-   `headers`:请求头.
-   `startTime`:请求开始的时间.
-   `error` (可选) : 请求中发生的任何错误 .

日志包括方法,状态代码,URL,以及请求开始以来所经过的时间.

```shell
  ✓ 100ms      GET     200 https://example.com
```

### logEvent 订阅器( 清空, 过滤器)

一个事件订阅者的日志细节 .

-   `query`: 用户正在监听的查询或查询数组.
-   `filter`: 应用到订阅者的过滤器(可选).

```shell
 ↳ on(user.created), {}
```

### 日志事件( 事件)

记录特定事件的详情 .

-   `event`: 事件对象日志 。 一定是这样 `topic`, (中文(简体) ), `createdAt`,以及 `id` 属性.

```shell
 ▶ user.created 5:58:30.572 PM 4hs98r
```

### 日志警告(消息),日志成功(消息),日志Error(消息,标签,前缀)

日志警告、成功和错误.

-   `message`: 要日志的信息 .
-   `label` 财务报告和审定财务报表 `prefix` 属于 `logError` 函数.

```shell
  ⚠️ Disk space running low
  ✅ File uploaded successfully
  🔴 Error:FileError File not found
```

### 日志( 回调)

一个通用日志方法,它接受一个将字符串返回日志的回调函数. 调用对象接收一个颜色对象,您可以用来将颜色应用到您信件的部分内容中.

## 安装

要安装 @ flatfile/ utils- debugger 包, 请使用 npm 或纱线 :

```
npm install @flatfile/utils-debugger
```

或者说

```
yarn add @flatfile/utils-debugger
```

## 依赖关系

此套件对调色控制台输出的ansi-colors套件有依赖性.

## 实例

```javascript
import { Debugger } from '@flatfile/utils-debugger'

Debugger.logHttpRequest({
  method: 'GET',
  url: 'https://example.com',
  statusCode: 200,
  headers: {},
  startTime: Date.now(),
})

Debugger.logEventSubscriber('user.created')

Debugger.logEvent({
  topic: 'user.created',
  createdAt: new Date(),
  id: 'abcd1234',
})

Debugger.logWarning('Disk space running low')

Debugger.logSuccess('File uploaded successfully')

Debugger.logError('File not found', 'FileError', 'Upload')
```

## 常见问题

### @flatfile/utils-debugger 是什么？

向控制台记录有用消息的助手

### 如何安装 @flatfile/utils-debugger？

在项目目录运行 npm install @flatfile/utils-debugger，或使用 pnpm add / yarn add / bun add。

### @flatfile/utils-debugger 支持 TypeScript 吗？

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

### @flatfile/utils-debugger 支持 ESM 还是 CommonJS？

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

### @flatfile/utils-debugger 可以商用吗？

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

### @flatfile/utils-debugger 的下载量有多少？

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

### @flatfile/utils-debugger 还在维护吗？

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