javascript - typescript 库: Hide internal exports

Question

我正在使用 typescript 构建一个库，并通过 npm 发布。

在作为库的起点的index.ts中，导出了所有公共(public)类和枚举。

import { MyClass } from './internal/my-class'
import { MyEnum } from './internal/my-enum'
export { MyClass, MyEnum }

这效果很好，但我注意到用户也可以通过使用文件的直接路径来导入内部函数/类等。

// in a project that installed my library as an npm dependency
import { InternalClass } from 'my-lib/dist/internal/internal-class'

有办法避免这种情况吗？

我需要“导出”InternalClass，因为我在整个库中导入并使用它，但我不想公开公开它。我尝试使用命名空间，但无法真正使其工作。

Answer 1

您应该将 tsconfig.json(或从命令行)中的 stripInternal 标志设置为 true 并使用 tsdoc 注释@internal 标记。

// internal/my_file.ts
/** @internal */
export function myInternalFunction() {}

请注意，这将从类型声明中删除该函数，因此它不会在编辑器中自动完成，但如果您确实需要隐藏内部详细信息，我建议您使用 Rollup 捆绑您的代码。使用 TypeScript 插件。