@fishka/logs

中文文档
1.0.0发布于 2026/02/16Apache-2.0TypeScriptESM + CJS零依赖近 30 天下载 6146

Console.log transformation pipes

原始使用文档
文档目录13 节
  1. Installation
  2. Quick Start
  3. Pipes
  4. JsonStringifyPipe
  5. JsonPipe
  6. LogLevelFilterPipe
  7. LogMessageFilterPipe
  8. LogCachePipe
  9. DateTimePipe
  10. Combining Pipes
  11. Uninstalling Pipes
  12. Custom Pipe
  13. License

@fishka/logs

Console.log transformation pipes for structured logging in TypeScript.

Installation

npm install @fishka/logs

Quick Start

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"}

Pipes

JsonStringifyPipe

Converts console arguments to a JSON string:

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

installConsoleOverride(createJsonStringifyPipe());

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

JsonPipe

Converts console arguments to a JSON object (without stringifying):

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

LogLevelFilterPipe

Filter logs by level:

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');

LogMessageFilterPipe

Filter logs by message content:

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

LogCachePipe

Cache recent logs:

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

DateTimePipe

Add timestamps to logs:

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

installConsoleOverride(createDateTimePipe());

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

Combining Pipes

Install multiple pipes in order:

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

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

Uninstalling Pipes

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

// Remove specific pipe
uninstallConsoleOverride(pipe);

// Remove all pipes
uninstallAllConsoleOverrides();

Custom Pipe

Create your own pipe:

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

Suppress logs by returning empty array:

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

Change log level by returning object:

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

License

Apache-2.0

版本与发布记录

@fishka/logs 共发布 1 个版本,首次发布于 2026/02/16;过去 12 个月发布了 1 个版本。

版本发布日期距今
1.0.0latest2026/02/168 个月前

关于 @fishka/logs 的常见问题

@fishka/logs 是什么?

Console.log transformation pipes

如何安装 @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 和提交记录判断。