# @faremeter/logs 中文文档

规范地址：https://npmcn.com/package/%40faremeter/logs/

版本：0\.22\.0
npm 元数据更新时间：2026-05-27T14:24:17.531Z
中文译文更新时间：2026-11-14T10:18:36.226Z
软件包许可：LGPL-3\.0-only

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

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

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

- 包体积（解压后）：119 kB，22 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@logtape/logtape 1\.0\.4
- 首次发布：2026-01-28T23:33:22.626Z
- 最新版本发布：2026-05-27T14:24:17.371Z
- 近 30 天下载量：3200（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：9（近 12 个月 9 个）

## 中文简介

Faremeter 可配置的伐木抽象

## 安装

```sh
npm install @faremeter/logs
```

也可以使用：`pnpm add @faremeter/logs`、`yarn add @faremeter/logs`、`bun add @faremeter/logs`

## README

# @faremeter/ 日志

带有可插件后端的可配置日志抽象.

## 安装

```bash
pnpm install @faremeter/logs
```

## 特征

-   覆盖所有软件包的统一日志接口
-   可插接后端( 控制台, 日志)
-   等级日志命名
-   运行时间后端互换

## API 参考

## 职能

-   [日志](https://npmcn.com/package/%40faremeter/logs/#readme-shouldlog)
-   [控制台备份.debug](https://npmcn.com/package/%40faremeter/logs/#readme-consolebackend.debug)
-   [配置辅助](https://npmcn.com/package/%40faremeter/logs/#readme-configureapp)
-   [获取潜行器](https://npmcn.com/package/%40faremeter/logs/#readme-getlogger)

### 日志

| 函数 | 类型 |
| --- | --- |
| `shouldLog` | `(level: "trace" or "debug" or "info" or "warning" or "error" or "fatal", configuredLevel: "trace" or "debug" or "info" or "warning" or "error" or "fatal") => boolean` |

### 控制台备份.debug

| 函数 | 类型 |
| --- | --- |
| `ConsoleBackend.debug` | `(message: string, context?: Context or undefined) => void` |

### 配置辅助

初始化全球伐木系统.

在应用程序启动时调用此选项以配置日志级别和后端 . 如果没有指定后端,则在可用时使用logtape,否则会掉入 返回控制台输出.

| 函数 | 类型 |
| --- | --- |
| `configureApp` | `(args?: ConfigureAppArgs) => Promise<void>` |

参数:

-   `args`: - 关卡和后端的配置选项.

实例:

```typescript
await configureApp({ level: "debug" });
```

### 获取潜行器

为特定子系统创建日志.

如果后端在之后更改, 返回的日志机会自动调整 创建( 例如, 当 QQlink 配置 App ) .

| 函数 | 类型 |
| --- | --- |
| `getLogger` | `(subsystem: readonly string[]) => Promise<Logger>` |

参数:

-   `subsystem`: - 日志的分级分类路径 .

回返情况:

一个日志实例被扩展到子系统 .

实例:

```typescript
const logger = await getLogger(["faremeter", "client"]);
logger.info("Client initialized", { version: "1.0.0" });
```

## 常数

-   [日志级别](https://npmcn.com/package/%40faremeter/logs/#readme-loglevels)

### 日志级别

| 常数 | 类型 |
| --- | --- |
| `LogLevels` | `readonly ["trace", "debug", "info", "warning", "error", "fatal"]` |

## 接口

-   [锁定器](https://npmcn.com/package/%40faremeter/logs/#readme-logger)
-   [日志 后端](https://npmcn.com/package/%40faremeter/logs/#readme-loggingbackend)
-   [配置 AppArgs 选项](https://npmcn.com/package/%40faremeter/logs/#readme-configureappargs)

### 锁定器

| 财产 | 类型 | 说明 |
| --- | --- | --- |

### 日志 后端

后端实施伐木系统.

后端处理日志输出目的地(主机、文件、外部服务) 并在运行时通过 QQlink 配置App} 互换 .

| 财产 | 类型 | 说明 |
| --- | --- | --- |

### 配置 AppArgs 选项

初始化日志系统的配置选项 .

| 财产 | 类型 | 说明 |
| --- | --- | --- |
| `level` | `"trace" or "debug" or "info" or "warning" or "error" or "fatal" or undefined` | 要发射的最小日志级别 。 默认为 `"info"`。 。 。 . |
| `backend` | `LoggingBackend<BaseConfigArgs> or undefined` | 后端执行要使用. 未提供自动检测. |

## 类型

-   [日志级别](https://npmcn.com/package/%40faremeter/logs/#readme-loglevel)
-   [A. 背景情况](https://npmcn.com/package/%40faremeter/logs/#readme-context)
-   [日志](https://npmcn.com/package/%40faremeter/logs/#readme-logargs)
-   [碱基ConfigArgs](https://npmcn.com/package/%40faremeter/logs/#readme-baseconfigargs)

### 日志级别

| 类型 | 类型 |
| --- | --- |
| `LogLevel` | `(typeof LogLevels)[number]` |

### A. 背景情况

| 类型 | 类型 |
| --- | --- |
| `Context` | `Record<string, unknown>` |

### 日志

| 类型 | 类型 |
| --- | --- |
| `LogArgs` | `[message: string, context?: Context]` |

### 碱基ConfigArgs

| 类型 | 类型 |
| --- | --- |
| `BaseConfigArgs` | `{ level: LogLevel }` |

## 相关软件包

-   [@ faremeter/ 中间软件](https://www.npmjs.com/package/@faremeter/middleware) - 服务器中间软件
-   [@faremeter/促进器](https://www.npmjs.com/package/@faremeter/facilitator) - 主持人服务器

## 许可证

LGPL-3.0 仅限

## 常见问题

### @faremeter/logs 是什么？

Faremeter 可配置的伐木抽象

### 如何安装 @faremeter/logs？

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

### @faremeter/logs 支持 TypeScript 吗？

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

### @faremeter/logs 支持 ESM 还是 CommonJS？

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

### @faremeter/logs 可以商用吗？

@faremeter/logs 使用 LGPL-3\.0-only 许可。弱 Copyleft：作为库被调用时通常不要求开源你自己的代码，但修改库本身需以 LGPL 开源；前端打包合并后的适用边界存在不同理解。以上为概括，不构成法律意见，请以许可原文为准。

### @faremeter/logs 的下载量有多少？

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

### @faremeter/logs 还在维护吗？

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