Typescript库:隐藏内部导出

Question

我正在构建一个通过npm发布的typescript库。

在作为库起点的index.ts中，所有公共类和枚举都被导出。

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插件捆绑您的代码。

Answer 2

使用microbundle或类似的工具来捆绑你的包。它应该生成一个文件，且您用户只能从入口点导入。

Answer 3

我觉得你做不到。

我想你可以使用TS的模块来编译成JS的IIFE，as described by Lucas Morgan here，但是我觉得这样做没有多大意义。如果你发布了开源软件，任何人都可以提取你的代码的任何部分。