For AI agents: the complete documentation index is available at /en/llms.txt, the full documentation bundle is available at /en/llms-full.txt, and this page is available as Markdown at /en/reference/sdk/logs/index.md.
  • English
  • logs

    Functions

    FunctionDescription
    stripAnsi移除字符串中包含的所有 ANSI 转义码。
    visibleLen计算字符串的终端可见字符长度(自动排除 ANSI 颜色与样式转义码)。
    supportsColor检测输出流是否支持彩色输出(遵循 NO_COLOR 与 FORCE_COLOR 环境变量行业规范)。
    wrap使用指定的 ANSI 颜色样式包裹目标字符串。
    mapBdsLevelToken将 BDS 级别词字符串映射为平台标准的 LogLevel 枚举(大小写不敏感)。
    stripBdsLogPrefix去掉 BDS 自带的 [时间 等级] 前缀,使正文从真正的有效消息开始。 具有幂等性:若已剥离过则原样返回。
    parseBdsEmbeddedLevel从单行文本中提取 BDS 内嵌的日志级别(优先提取行首前缀,未命中时在全文中查找首次出现的标记)。 例如:[2026-07-25 18:42:27:626 warn] [Commands] ... → "warn"。
    inferLevel从原始文本行推断日志级别(BDS 时间戳前缀优先,未命中时按常见关键词推断)。
    padSource将 source 来源标识字段右侧填充空格至指定的终端可见宽度。
    levelTag生成紧凑形式的级别标签字符串(例如 [INF]、[WRN]、[ERR]、[OK]、[DBG])。
    levelTagFull完整级别标签: [INFO] [WARN] [ERROR] [OK] [DEBUG]
    highlightText高亮文本中的关键系统词,并剥离 Minecraft 原生的 § 样式颜色代码。
    formatLogLine格式化单行日志(供子进程 stdout 输出及持久化日志文件落盘)。 输出格式:<ISO时间> [source] [LEVEL] text。
    formatLog格式化日志条目供控制台或 REPL 界面展示。 输出格式:<localTime> <paddedSource> <levelTag> <text>。
    createNodeServiceLogger创建 Node 独立服务的标准 Logger 实例:同时输出至终端与持久化日志文件。
    createLogger创建通用 Logger 实例。
    getOutputLinegetOutputLine — 给定 entry,返回它会被 sink 输出的字符串 (供测试/调试)
    createMemoryBuffer创建进程内环形内存日志缓冲。
    createStdoutSink创建 stdout 日志 sink(可选颜色与 error 路由 stderr)。
    createFileSink创建文件追加 sink(纯文本、同步写入)。
    createCallbackSink创建回调转发 sink(用于子进程 stdout 捕获等场景)。
    hasActiveProgress是否有活跃进度条(含 pause 中)
    pauseAllProgress日志写行前:清掉进度条行
    resumeAllProgress日志写行后:重绘进度条
    withProgressPaused包裹一次会写终端的操作,避免与进度条抢行
    formatDownloadSpeed下载速度文案(BDS / CF 等共用,避免各处复制阈值分支)
    bindByteProgressToBar把字节进度接到 TerminalProgress(MB 刻度 + 速度文案)。 BDS 更新与 CF 包下载共用,避免两处复制 lastTime/lastLoaded 环路(DRY)。
    createTerminalProgress创建进度句柄。TTY 时画 bar;非 TTY 时按步进打 logger。
    withTerminalProgress在异步任务期间持有进度条,结束时保证 stop

    Interfaces

    InterfaceDescription
    LoggerOptionsLogger 构建配置选项。
    Logger统一日志记录器接口。
    NodeServiceLoggerNode 服务标准 Logger 实例接口:包含标准输出与日志文件落盘。
    NodeServiceLoggerOptionsNode 进程日志记录器配置选项。
    MemoryBuffer-
    StdoutSinkOptions-
    FileSinkOptions-
    FileSinkSink — 日志输出的抽象目标 (stdout / file / memory buffer / 自定义) write() 接收原始 entry 和已格式化字符串,实现自行选择使用哪个。
    TerminalProgressOptions终端进度条选项。
    ProgressHandle进度条操作句柄。
    DownloadProgressBinderOptions字节下载进度绑定选项。
    LogEntry单条日志条目。
    SinkSink — 日志输出的抽象目标 (stdout / file / memory buffer / 自定义) write() 接收原始 entry 和已格式化字符串,实现自行选择使用哪个。
    FormatOptions@sfmc-bds/logs — ScriptsForMinecraftServer 统一日志接口

    Type Aliases

    Type AliasDescription
    ProgressLogFn-
    LogLevel日志级别。
    LogSource日志来源标识(如 db / qq / system)。

    Variables

    VariableDescription
    ansiANSI 转义码常量(One Dark 风格配色)。