# @debugr/slack 中文文档

规范地址：https://npmcn.com/package/%40debugr/slack/

版本：4\.0\.0
npm 元数据更新时间：2026-08-13T21:36:30.961Z
中文译文更新时间：2026-11-11T18:59:01.568Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：13 kB，13 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=24
- 运行依赖：1 个
- 首次发布：2022-11-21T16:26:42.537Z
- 最新版本发布：2026-08-13T21:36:30.566Z
- 近 30 天下载量：7844（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：4（近 12 个月 1 个）

## 中文简介

要调试的弹性日志处理器

## 安装

```sh
npm install @debugr/slack
```

也可以使用：`pnpm add @debugr/slack`、`yarn add @debugr/slack`、`bun add @debugr/slack`

## README

# 调试器的黑日志处理器

此日志处理器会发送每个条目, 其日志级别为或高于所配置的阈值 作为已配置的 Slack 频道的消息.

## 安装

```bash
npm install --save @debugr/slack
```

## 使用量

```typescript
import { Logger, LogLevel } from '@debugr/core';
import { SlackHandler } from '@debugr/slack';

const globalContext = {
  applicationName: 'example',
};

const logger = new Logger(globalContext, [
  new SlackHandler({
    threshold: LogLevel.FATAL,
    webhookUrl: 'your slack webhook url',
  }),
]);

logger.fatal('Something failed miserably!');
```

这个 `SlackHandler` 构造器接受一个 _所需经费_ `options` 对象 以下键作为第一个参数:

| 选项 | 类型 | 默认 | 说明 |
| --- | --- | --- | --- |
| `webhookUrl` | `string` | _(必须)_ | Slack webhook URL; 见 [黑 API 文件](https://api.slack.com/messaging/webhooks) 如何获得一个. |
| `threshold` | `LogLevel` | `LogLevel.ERROR` | 将发布到所配置的频道的最低级别条目 。 此关卡以下的任何条目都将被忽略 . |
| `channel` | `string` |  | Slack频道ID 消息应该张贴到. 这只管用 [遗留的 Slack 网络呼号](https://api.slack.com/legacy/custom-integrations/messaging/webhooks)。 。 。 . |
| `username` | `string` |  | 消息的用户名应该放在下面。 这只管用 [遗留的 Slack 网络呼号](https://api.slack.com/legacy/custom-integrations/messaging/webhooks)。 。 。 . |
| `iconUrl` | `string` |  | 用于替换默认图标的图标的 URL。 这只管用 [遗留的 Slack 网络呼号](https://api.slack.com/legacy/custom-integrations/messaging/webhooks)。 。 。 . |
| `iconEmoji` | `string` |  | 用于替换默认图标的 emoji 代码字符串 。 这只管用 [遗留的 Slack 网络呼号](https://api.slack.com/legacy/custom-integrations/messaging/webhooks)。 。 。 . |
| `errorCallback` | `(err: Error) => void` | _(见说明)_ | 向 Slack 发送消息时会调用回调失败 。 默认的回调会简单地将错误记录入控制台. |
| `bodyMapper` | `(entry: LogEntry) => Record<string, any>` | _(见说明)_ | 将日志条目映射到要发送到已配置的 Webhook URL的回调 。 有效载荷至少必须包括: `text` 键为 a `string` 内容. |

## 常见问题

### @debugr/slack 是什么？

要调试的弹性日志处理器

### 如何安装 @debugr/slack？

在项目目录运行 npm install @debugr/slack，或使用 pnpm add / yarn add / bun add。

### @debugr/slack 支持 TypeScript 吗？

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

### @debugr/slack 支持 ESM 还是 CommonJS？

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

### @debugr/slack 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=24。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @debugr/slack 可以商用吗？

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

### @debugr/slack 的下载量有多少？

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

### @debugr/slack 还在维护吗？

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