Marked.js 类型声明与实现不一致问题分析

问题背景

在 Marked.js 14.0.0 版本中，TypeScript 类型声明文件(marked.d.ts)声明了两个常量 block 和 inline 为导出项，但实际上这些常量并未在模块的导出列表中出现。这种类型声明与实际实现不一致的情况会导致 TypeScript 开发者遇到运行时错误。

技术细节

Marked.js 的类型声明文件中包含以下导出声明：

export declare const block: {
    // 类型定义
};
export declare const inline: {
    // 类型定义
};

然而，在模块的实际实现中(包括 ESM、CJS 和 UMD 格式)，这些常量并未被真正导出。例如在 marked.esm.js 中，导出的只有以下内容：

export { Hooks, Lexer, Marked, Parser, Renderer, TextRenderer, Tokenizer, defaults, getDefaults, lexer, marked, options, parse, parseInline, parser, setOptions, use, walkTokens };

影响分析

这种不一致会导致以下问题：

1. TypeScript 编译时不会报错，开发者可以正常导入这些不存在的导出项
2. 运行时会出现模块导出不存在的错误
3. 破坏了 TypeScript 的类型安全性保证

解决方案

项目维护者确认这是一个需要修复的问题，并指出：

1. block 和 inline 是内部实现细节，不应暴露给外部使用
2. 这些内部结构可能会在不发布主版本更新的情况下发生变化
3. 正确的修复方式是修改类型声明文件，移除这些错误的导出声明

替代方案

对于需要访问 Marked.js 内部 token 结构的开发者，维护者建议使用以下方法：

1. 使用 marked.lexer(src, options) 方法获取 token 树
2. 通过 hooks.processAllTokens 钩子访问 lexer 输出的 token 树
3. 这些 API 是官方支持的稳定接口，更适合开发者使用

总结

这个案例提醒我们：

1. 类型声明文件必须与实际实现保持严格一致
2. 内部实现细节不应暴露在公共 API 中
3. 开发者应使用官方文档支持的 API 而非内部实现

对于 Marked.js 用户，建议升级到修复此问题的版本，并避免依赖未文档化的内部结构。