Appearance
轻量级调试日志工具,适合 CLI 或 Node.js 工具在调试模式下输出结构化日志。
安装
bash
pnpm add @mingto/debug快速开始
typescript
import Debug from '@mingto/debug'
const debug = new Debug()
debug.enable(true)
debug.log('开始执行任务', { step: 1 })
debug.disable()
debug.log('这条日志不会输出')也可以使用命名导出:
typescript
import { Debug } from '@mingto/debug'
const debug = new Debug()API
enable(enabled?)
启用或关闭调试模式。
| 参数 | 类型 | 默认值 | 说明 |
|---|---|---|---|
enabled | boolean | false | 是否启用调试输出。不传时会关闭调试模式 |
typescript
debug.enable(true)
debug.enable(false)
debug.enable()disable()
关闭调试模式。
typescript
debug.disable()isEnabled()
返回当前是否启用了调试模式。
typescript
const enabled = debug.isEnabled()log(message, ...args)
在调试模式开启时输出日志。日志前缀固定为 [DEBUG],额外参数会被格式化后拼接到消息后面。
| 参数 | 类型 | 说明 |
|---|---|---|
message | string | 日志消息 |
...args | any[] | 额外日志参数 |
typescript
debug.enable(true)
debug.log('请求参数', { id: 1, name: 'demo' })格式化规则
null、undefined会输出为对应字符串- 字符串、数字、布尔值会直接转换为字符串
- 函数会输出为
[Function: name]或[Function: anonymous] symbol与bigint会按自身表示输出- 对象会通过
JSON.stringify格式化,循环引用会显示为[Circular] - 对象格式化结果超过 1000 个字符时会被截断