debug

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Debug Package Usage Guide

Debug包使用指南

Basic Usage

基础用法

typescript
import debug from 'debug';

// Format: lobe-[module]:[submodule]
const log = debug('lobe-server:market');

log('Simple message');
log('With variable: %O', object);
log('Formatted number: %d', number);
typescript
import debug from 'debug';

// 格式:lobe-[module]:[submodule]
const log = debug('lobe-server:market');

log('简单消息');
log('包含变量:%O', object);
log('格式化数字:%d', number);

Namespace Conventions

命名空间约定

  • Desktop:
    lobe-desktop:[module]
  • Server:
    lobe-server:[module]
  • Client:
    lobe-client:[module]
  • Router:
    lobe-[type]-router:[module]
  • 桌面端:
    lobe-desktop:[module]
  • 服务端:
    lobe-server:[module]
  • 客户端:
    lobe-client:[module]
  • 路由:
    lobe-[type]-router:[module]

Format Specifiers

格式说明符

  • %O
    - Object expanded (recommended for complex objects)
  • %o
    - Object
  • %s
    - String
  • %d
    - Number
  • %O
    - 展开显示对象(推荐用于复杂对象)
  • %o
    - 对象
  • %s
    - 字符串
  • %d
    - 数字

Enable Debug Output

启用调试输出

Browser

浏览器

javascript
localStorage.debug = 'lobe-*';
javascript
localStorage.debug = 'lobe-*';

Node.js

Node.js

bash
DEBUG=lobe-* npm run dev
DEBUG=lobe-* pnpm dev
bash
DEBUG=lobe-* npm run dev
DEBUG=lobe-* pnpm dev

Electron

Electron

typescript
process.env.DEBUG = 'lobe-*';
typescript
process.env.DEBUG = 'lobe-*';

Example

示例

typescript
// src/server/routers/edge/market/index.ts
import debug from 'debug';

const log = debug('lobe-edge-router:market');

log('getAgent input: %O', input);
typescript
// src/server/routers/edge/market/index.ts
import debug from 'debug';

const log = debug('lobe-edge-router:market');

log('getAgent 输入参数:%O', input);