# @eliware/log 中文文档

规范地址：https://npmcn.com/package/%40eliware/log/

版本：15\.0\.1
npm 元数据更新时间：2026-10-27T00:12:42.565Z
中文译文更新时间：2026-11-13T23:49:20.657Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：49.5 kB，28 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=26
- 运行依赖：3 个
- 首次发布：2025-12-08T19:29:44.676Z
- 最新版本发布：2026-10-27T00:12:42.205Z
- 近 30 天下载量：2862（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：22（近 12 个月 22 个）

## 中文简介

以温斯顿为后盾,对节点进行结构化的无害环境管理记录,并进行编辑和防御序列化.

## 安装

```sh
npm install @eliware/log
```

也可以使用：`pnpm add @eliware/log`、`yarn add @eliware/log`、`bun add @eliware/log`

## README

# [![eliware.org](https://eliware.org/logos/brand.png)](https://discord.gg/M6aTR9eTwN)

## @ eliware/ log (帮助) [![npm](https://img.shields.io/npm/v/@eliware/log)](https://www.npmjs.com/package/@eliware/log) [![License](https://img.shields.io/github/license/eliware/log)](https://github.com/eliware/log/blob/main/LICENSE) [![CI](https://github.com/eliware/log/actions/workflows/ci.yaml/badge.svg)](https://github.com/eliware/log/actions/workflows/ci.yaml)

以温斯顿为后盾,对节点进行结构化的无害环境管理记录,并进行编辑和防御序列化.

## 目录

-   [特征](https://npmcn.com/package/%40eliware/log/#readme-features)
-   [所需资源](https://npmcn.com/package/%40eliware/log/#readme-requirements)
-   [设置](https://npmcn.com/package/%40eliware/log/#readme-setup)
-   [使用量](https://npmcn.com/package/%40eliware/log/#readme-usage)
-   [发展](https://npmcn.com/package/%40eliware/log/#readme-development)
-   [测试](https://npmcn.com/package/%40eliware/log/#readme-testing)
-   [解决问题](https://npmcn.com/package/%40eliware/log/#readme-troubleshooting)
-   [警卫](https://npmcn.com/package/%40eliware/log/#readme-security)
-   [API 密码](https://npmcn.com/package/%40eliware/log/#readme-api)
-   [包装](https://npmcn.com/package/%40eliware/log/#readme-packaging)
-   [实例](https://npmcn.com/package/%40eliware/log/#readme-examples)
-   [支助](https://npmcn.com/package/%40eliware/log/#readme-support)
-   [链接](https://npmcn.com/package/%40eliware/log/#readme-links)
-   [许可证](https://npmcn.com/package/%40eliware/log/#readme-license)

## 特征

-   创建带有文本或JSON输出的温斯顿日志器,分级过滤,并配置可配置的传输.
-   在请求或其他操作中加入共享的上下文 .
-   在软件包发送记录到传送之前编辑选中的元数据密钥 .
-   对序列化对象和错误应用已配置的输出限制 。 序列器不调用 `toJSON()`。 。 。 .
-   设定时在 JSON 记录中添加时间戳 `timestamp: true`。 。 。 .

读取 [文档](https://npmcn.com/package/%40eliware/log/docs/README.md) 用于设置和使用。 读取 [规格](https://npmcn.com/package/%40eliware/log/specs/README.md) 用于包件要求.

## 所需资源

在本土无害环境管理项目中使用节点26或以后使用.

## 设置

用 npm 安装软件包 :

```sh
npm install @eliware/log
```

## 使用量

导入 `createLogger()` 从包根创建日志 :

```js
import { createLogger } from "@eliware/log";

const logger = createLogger({ format: "json" });
logger.info("Request received", { requestId: "demo" });
```

读取 [发布注释](https://npmcn.com/package/%40eliware/log/RELEASE_NOTES.md) 用于修改软件包.

## 发展

运行 `npm ci` 以安装锁文件依赖性.

## 测试

运行 `npm test` 用于汇总验证。 运行 `npm run lint`, (中文(简体) ), `npm run audit`, (中文(简体) ), `npm run format:check`, (中文(简体) ), `npm run typecheck`,或 `npm run pack` 用于重点检查。 运行 `npm run format` 以格式化文件.

## 解决问题

| 问题 | 原因 | 行动 |
| --- | --- | --- |
| `createLogger()` 报告无效关卡 | 温斯顿没有定义关卡. | 设定 `level` 达到温斯顿所支持的水平. |
| `createLogger()` 报告无效的格式 | 格式没有 `text` 或者说 `json`。 。 。 . | 设定 `format` 改为 `text` 或者说 `json`。 。 。 . |
| `timestamp must be a boolean` | 这个 `timestamp` 选项不是布尔. | 设定 `timestamp` 改为 `true` 或者说 `false`。 。 。 . |
| `transports must be an array` | 这个 `transports` 选项不是数组. | 通过一系列温斯顿运输. |
| 缺少日志记录 | 配置的关卡过滤它,或者传输会改变输出. | 检查关卡并检查运输输出. |

## 警卫

设定 `keys` 改为含有敏感数据的元数据属性名称。 日志不按属性名称编辑字符串消息 。 在登录信件前删除信件中的秘密 .

检查每个自定义运输的最终输出. 运输可以添加字段或更改记录. 不使用编辑或限定序列来取代日志存储的访问控制.

## API 密码

从包根导入日志和编辑函数 。 根还导出编辑选项类型和现有的 `RedactionOptions` 别名.

读取 [API 参考](https://npmcn.com/package/%40eliware/log/docs/api-reference.md) 用于函数行为、选项、声明和方法.

## 包装

软件包包括 `package.json` 和列表中的文件 `package.json.files`数字 : `src/`, (中文(简体) ), `docs/`, (中文(简体) ), `README.md`, (中文(简体) ), `AGENTS.md`, (中文(简体) ), `LICENSE`, (中文(简体) ), `RELEASE_NOTES.md`, (中文(简体) ), `examples/`, (中文(简体) ), `specs/`,以及 `.env.example`。 。 。 . 使用数字 `MAJOR.MINOR.PATCH` 版本和匹配 `v<version>` 释放标签. 在发布前通过业务发布会获得批准.

## 实例

读取 [实例/README.md](https://npmcn.com/package/%40eliware/log/examples/README.md) 命令和预期结果.

## 支助

为了帮助、提问或与提交人和社区交谈,访问:

[![Discord](https://eliware.org/logos/discord_96.png)](https://discord.gg/M6aTR9eTwN)[![eliware.org](https://eliware.org/logos/eliware_96.png)](https://discord.gg/M6aTR9eTwN)

**[eliware.org 关于迪斯科尔](https://discord.gg/M6aTR9eTwN)**

## 链接

-   [主页](https://eliware.org/)
-   [GitHub 图标](https://github.com/eliware)
-   [GitHub 重现](https://github.com/eliware/log)
-   [错误报告](https://github.com/eliware/log/issues)
-   [无](https://www.npmjs.com/package/@eliware/log)
-   [解析器](https://discord.gg/M6aTR9eTwN)

## 许可证

[麻省理工学院 Eliware](https://npmcn.com/package/%40eliware/log/LICENSE)

## 常见问题

### @eliware/log 是什么？

以温斯顿为后盾,对节点进行结构化的无害环境管理记录,并进行编辑和防御序列化\.

### 如何安装 @eliware/log？

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

### @eliware/log 支持 TypeScript 吗？

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

### @eliware/log 支持 ESM 还是 CommonJS？

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

### @eliware/log 需要什么版本的 Node\.js？

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

### @eliware/log 可以商用吗？

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

### @eliware/log 的下载量有多少？

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

### @eliware/log 还在维护吗？

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