@chubbyts/chubbyts-log-types

中文文档
3.4.1发布于 2026/11/10MITTypeScriptES Module零依赖近 30 天下载 1779

Log (logger) types, PSR-3 inspired.

原始使用文档
文档目录10 节
  1. Description
  2. Requirements
  3. Installation
  4. Usage
  5. Types
  6. Create a logger
  7. Null logger
  8. Depend on the type
  9. Filter by level
  10. Copyright

chubbyts-log-types

CI Coverage Status Mutation testing badge npm-version

bugs code_smells coverage duplicated_lines_density ncloc sqale_rating alert_status reliability_rating security_rating sqale_index vulnerabilities

Description

Log (logger) types, PSR-3 inspired.

The package ships only types and a tiny createLogger helper, so libraries can depend on a logger contract without depending on a concrete logging implementation.

Requirements

  • node: >=22

Installation

Through NPM as @chubbyts/chubbyts-log-types.

npm i @chubbyts/chubbyts-log-types@^3.4.1

Usage

Types

import type {
  Context,
  LogFn,
  Logger,
  LogLevel,
  NamedLogFn,
} from '@chubbyts/chubbyts-log-types/log';
type LogLevel =
  | 'emergency'
  | 'alert'
  | 'critical'
  | 'error'
  | 'warning'
  | 'notice'
  | 'info'
  | 'debug';

type Context = Record<string, unknown>;

type LogFn = (level: LogLevel, message: string, context: Context) => void;
type NamedLogFn = (message: string, context: Context) => void;

// one NamedLogFn per LogLevel, plus the generic log function
type Logger = Record<LogLevel, NamedLogFn> & { log: LogFn };

Create a logger

createLogger takes a single LogFn and derives all level-specific methods from it.

import { createLogger } from '@chubbyts/chubbyts-log-types/log';

const logger = createLogger((level, message, context) => {
  const datetime = new Date().toISOString();

  console.log(JSON.stringify({ datetime, level, message, context }));
});

logger.info('User logged in', { userId: 'a1b2c3' });
logger.error('Payment failed', { orderId: 42, reason: 'card declined' });
logger.log('warning', 'Disk space low', { freeBytes: 1_024 });

Null logger

Without an argument createLogger returns a logger that discards every message, which is handy as a default or within tests.

import { createLogger } from '@chubbyts/chubbyts-log-types/log';

const logger = createLogger();

logger.debug('This goes nowhere', {});

Depend on the type

Accept a Logger instead of a concrete implementation.

import type { Logger } from '@chubbyts/chubbyts-log-types/log';
import { createLogger } from '@chubbyts/chubbyts-log-types/log';

export const createUserService = (logger: Logger = createLogger()) => ({
  delete: (id: string) => {
    logger.notice('User deleted', { id });
  },
});

Filter by level

import type { LogFn, LogLevel } from '@chubbyts/chubbyts-log-types/log';
import { createLogger } from '@chubbyts/chubbyts-log-types/log';

// ordered from most to least severe
const levels: Array<LogLevel> = [
  'emergency',
  'alert',
  'critical',
  'error',
  'warning',
  'notice',
  'info',
  'debug',
];

const createMinLevelLogFn =
  (minLevel: LogLevel, log: LogFn): LogFn =>
  (level, message, context) => {
    if (levels.indexOf(level) <= levels.indexOf(minLevel)) {
      log(level, message, context);
    }
  };

const logger = createLogger(
  createMinLevelLogFn('warning', (level, message, context) => {
    console.log(level, message, context);
  }),
);

logger.error('Shown', {});
logger.info('Suppressed', {});

2026 Dominik Zogg

版本与发布记录

@chubbyts/chubbyts-log-types 共发布 24 个版本,首次发布于 2022/05/26;过去 12 个月发布了 8 个版本。

版本发布日期距今
3.4.1latest2026/11/10今天
3.4.02026/11/081 天前
3.3.12026/10/2021 天前
3.3.02026/07/283 个月前
3.2.02026/05/106 个月前
3.1.12026/04/186 个月前

关于 @chubbyts/chubbyts-log-types 的常见问题

@chubbyts/chubbyts-log-types 是什么?

Log (logger) types, PSR-3 inspired.

如何安装 @chubbyts/chubbyts-log-types?

在项目目录运行 npm install @chubbyts/chubbyts-log-types,或使用 pnpm add / yarn add / bun add。

@chubbyts/chubbyts-log-types 支持 TypeScript 吗?

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

@chubbyts/chubbyts-log-types 支持 ESM 还是 CommonJS?

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

@chubbyts/chubbyts-log-types 需要什么版本的 Node.js?

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

@chubbyts/chubbyts-log-types 可以商用吗?

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

@chubbyts/chubbyts-log-types 的下载量有多少?

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

@chubbyts/chubbyts-log-types 还在维护吗?

最新版本 3.4.1 发布于 2026/11/10(今天);至今共发布 24 个版本,其中过去 12 个月发布了 8 个;首次发布于 2022/05/26。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。