Markdoc项目中类型导出导致实例化不便的问题分析

在Markdoc项目(一个结构化内容标记语言库)的使用过程中，开发者发现了一个与TypeScript类型导出相关的设计问题，这个问题影响了开发者对核心类Node的直接实例化能力。

问题背景

Markdoc项目通过export type方式导出了Node类型，这种导出方式导致开发者无法直接使用new Node()语法创建实例。当开发者尝试直接实例化时，TypeScript会抛出错误："'Node' cannot be used as a value because it was exported using 'export type'"。

问题表现

开发者通常期望能够这样使用：

import { Node } from '@markdoc/markdoc';

function createNode(): Node {
    return new Node('tag', {}, [], 'foo');
}

但由于当前导出方式，开发者被迫采用更冗长的替代方案：

import Markdoc, { Node } from '@markdoc/markdoc';

function createNode(): Node {
    return new Markdoc.Ast.Node('tag', {}, [], 'foo');
}

技术分析

这个问题源于TypeScript的类型导出(export type)与值导出(export)的区别。当使用export type导出时，该标识符仅能在类型上下文中使用，而不能作为值(如构造函数)使用。这种设计在纯类型库中很常见，但对于同时提供运行时功能的库来说可能会造成不便。

解决方案

项目维护者已经接受了修改导出方式的PR，将Node类改为常规导出，允许开发者直接实例化。这种修改平衡了类型安全性和开发便利性，是更符合用户直觉的API设计。

最佳实践建议

对于类库开发者，当设计同时包含类型和运行时功能的API时：

1. 对于既作为类型又作为构造函数的类，应使用常规export而非export type
2. 保持类型导出的一致性，避免混合使用不同导出方式导致混淆
3. 在文档中明确说明哪些导出可以直接实例化

这种设计决策能够显著改善开发者体验，减少不必要的间接引用层级。