# @fishka/logs 中文文档

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

版本：1\.0\.0
npm 元数据更新时间：2026-02-16T04:11:44.551Z
中文译文更新时间：2026-11-14T20:28:26.867Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40fishka/logs
原文对照：https://npmcn.com/package/%40fishka/logs/?lang=original
源码仓库：https://gitea.com/fishka/assertions

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

- 包体积（解压后）：188 kB，102 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=10
- 运行依赖：0 个
- 首次发布：2026-02-16T04:11:44.062Z
- 最新版本发布：2026-02-16T04:11:44.318Z
- 近 30 天下载量：6146（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：1（近 12 个月 1 个）

## 中文简介

Console.log 变形管

## 安装

```sh
npm install @fishka/logs
```

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

## README

# @ fishka/ 日志

在TypeScript中用于结构化日志的 Console.log 转换管.

## 安装

```bash
npm install @fishka/logs
```

## 快速启动

```typescript
import {createJsonStringifyPipe, installConsoleOverride} from '@fishka/logs';

// Install JSON stringify pipe
installConsoleOverride(createJsonStringifyPipe());

// Now all console logs are JSON formatted
console.log('User logged in', {userId: 123, action: 'login'});
// Output: {"message":"User logged in $1","$1":{"userId":123,"action":"login"},"level":"log","timestamp":"2026-02-15T04:30:00.000Z","message_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"}
```

## 管道

### JsonStringify Pipe (英语)

将控制台参数转换为 JSON 字符串 :

```typescript
import {createJsonStringifyPipe, installConsoleOverride} from '@fishka/logs';

installConsoleOverride(createJsonStringifyPipe());

console.log('Hello', {data: 'value'});
// {"message":"Hello $1","$1":{"data":"value"},"level":"log","timestamp":"...","message_id":"..."}
```

### 贾森皮普

将控制台参数转换为 JSON 对象( 不字符串) :

```typescript
import {createJsonPipe, installConsoleOverride} from '@fishka/logs';

const pipe = createJsonPipe();
installConsoleOverride(pipe);

// Access last message ID
console.log('Test');
console.log(pipe.getLastMessageId()); // "a1b2c3d4-..."

// Set next message ID
pipe.setNextMessageId('custom-id-123');
console.log('Test'); // Uses "custom-id-123" as message_id
```

### 日志级别FilterPipe

按级别过滤日志 :

```typescript
import {createLogLevelFilterPipe, installConsoleOverride} from '@fishka/logs';

// Exclude debug and trace logs
installConsoleOverride(createLogLevelFilterPipe({
    excludedLogLevels: ['debug', 'trace']
}));

console.debug('This will not appear');
console.log('This will appear');
```

### 日志编辑器Pipe

按信件内容过滤日志 :

```typescript
import {createLogMessageFilterPipe, installConsoleOverride} from '@fishka/logs';

// Exclude messages containing "password"
installConsoleOverride(createLogMessageFilterPipe({
    excludedMessagePatterns: [/password/i]
}));

console.log('User password: secret123'); // Filtered out
console.log('User login: john'); // Allowed
```

### 日志卡切Pipe

缓存最近日志 :

```typescript
import {createLogCachePipe, installConsoleOverride} from '@fishka/logs';

const cachePipe = createLogCachePipe({maxCacheSize: 100});
installConsoleOverride(cachePipe);

console.log('Message 1');
console.log('Message 2');

// Access cached logs
console.log(cachePipe.getLogCache()); // Array of recent logs
```

### 日期时间

在日志中添加时间戳 :

```typescript
import {createDateTimePipe, installConsoleOverride} from '@fishka/logs';

installConsoleOverride(createDateTimePipe());

console.log('Event');
// [2026-02-15T04:30:00.000Z] Event
```

## 组合管道

安装多管的顺序 :

```typescript
import {
    createLogLevelFilterPipe,
    createJsonStringifyPipe,
    installConsoleOverrides
} from '@fishka/logs';

installConsoleOverrides(
    createLogLevelFilterPipe({excludedLogLevels: ['debug']}),
    createJsonStringifyPipe()
);
```

## 未安装管道

```typescript
import {uninstallConsoleOverride, uninstallAllConsoleOverrides} from '@fishka/logs';

// Remove specific pipe
uninstallConsoleOverride(pipe);

// Remove all pipes
uninstallAllConsoleOverrides();
```

## 自定义管道

创建您的管道 :

```typescript
import {LogPipe, installConsoleOverride} from '@fishka/logs';

const myPipe: LogPipe = (level, ...args) => {
    // Transform arguments
    return args.map(arg => typeof arg === 'string' ? arg.toUpperCase() : arg);
};

installConsoleOverride(myPipe);

console.log('hello'); // HELLO
```

通过返回空数组来压制日志 :

```typescript
const suppressPipe: LogPipe = () => [];
```

通过返回对象更改日志级别 :

```typescript
const upgradePipe: LogPipe = (level, ...args) => ({
    level: 'error', // Upgrade all logs to error
    args
});
```

## 许可证

阿帕奇 - 2.0

## 常见问题

### @fishka/logs 是什么？

Console\.log 变形管

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

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

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

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

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

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

### @fishka/logs 需要什么版本的 Node\.js？

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

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

@fishka/logs 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

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

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

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

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