时间戳

首页 > 解决方案 > Typescript 库：隐藏内部导出

javascript - Typescript 库：隐藏内部导出

问题描述

我正在使用通过 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，因为我在整个库中导入和使用它，但我不想公开它。我尝试使用命名空间，但无法真正让它工作。

标签： javascripttypescriptmoduleshared-libraries

解决方案

您应该在您的（或从命令行）中设置stripInternal标志并使用带有标签的 tsdoc 注释。tsconfig.jsontrue@internal

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

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

推荐阅读