# @eaboy/clean-console 中文文档

规范地址：https://npmcn.com/package/%40eaboy/clean-console/

版本：1\.0\.4
npm 元数据更新时间：2022-04-05T06:20:55.381Z
中文译文更新时间：2026-11-13T04:24:05.447Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：9 kB，9 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2020-06-17T17:54:03.194Z
- 最新版本发布：2020-06-19T18:02:04.076Z
- 近 30 天下载量：2325（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：5（近 12 个月 0 个）

## 中文简介

一个简单的库来保持您的网站控制台或应用程序的清洁

## 安装

```sh
npm install @eaboy/clean-console
```

也可以使用：`pnpm add @eaboy/clean-console`、`yarn add @eaboy/clean-console`、`bun add @eaboy/clean-console`

## README

# 清洁控制台

一个简单的库来保持您的网站或应用程序的操纵台清洁. 控制台上不再印有日志,出错,警告等内容,人人可见. 您也可以向好奇的访客展示美妙的讯息.

![clean-console with initial message](https://github.com/eaboy/clean-console/raw/master/img/initial_message.png)

如果您想要看到用于调试的日志, 您只需设置一个本地存储键以获取真实性, 然后通过该键作为配置的一部分 .

![clean-console with local storage key](https://github.com/eaboy/clean-console/raw/master/img/local_storage_key.png)

## 安装

```
npm i @eaboy/clean-console
```

## 使用量

默认使用 :

```js
import { CleanConsole } from '@eaboy/clean-console';

CleanConsole.init() // Dafault behavior
```

自定义用法 :

```js
import { CleanConsole } from '@eaboy/clean-console';

CleanConsole.init(configOptions) // Object parameter for coustom options
```

您也可以在页面中直接加载 clean-console.min.js,并在代码中调用init方法:

```js
cleanConsole.init(configOptions) // Object parameter for coustom options
```

## 配置选项

要自定义行为, 您可以用以下属性通过配置对象 。 所有属性都是可选的 :

| 名称 | 类型 | 默认 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| `excludeMethods` | 数组 |  | 用控制台的方法传递一系列字符串,您想要在控制台上继续看到 | `excludeMethods: ['error', 'info', 'clear']` |
| `clearOnInit` | 布尔 | 虚假 | 如果您想要在清理控制台运行前清除控制台, 设置为真实, 如果库初始化前打印了日志, 则有用 | `clearOnInit: true` |
| `debugLocalStoregeKey` | 字符串 |  | 设定您要使用的本地存储密钥, 以阻止库的执行, 并能够看到用于调试的所有日志 | `debugLocalStoregeKey: 'my_awesome_site_key'` |
| `initialMessages` | 数组 |  | 以属性传递一系列对象 `message` 它包含您想要显示在控制台上的信息,以及可选的属性 `style` 带有您想要应用到信件的 Css 样式。 您可以通过您想要显示的信件中尽可能多的对象 | `initialMessages: { message: 'Thanks for visiting my awesome site!', style: 'color: red; font-size: 28px; font-weight: bold; font-family: "Comic Sans MS", cursive, sans-serif; line-height: 38px;' }` |

## 常见问题

### @eaboy/clean-console 是什么？

一个简单的库来保持您的网站控制台或应用程序的清洁

### 如何安装 @eaboy/clean-console？

在项目目录运行 npm install @eaboy/clean-console，或使用 pnpm add / yarn add / bun add。

### @eaboy/clean-console 支持 TypeScript 吗？

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

### @eaboy/clean-console 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @eaboy/clean-console 可以商用吗？

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

### @eaboy/clean-console 的下载量有多少？

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

### @eaboy/clean-console 还在维护吗？

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