从 js 中隐藏 function（仅限打字稿功能）

Question

我有一个 javascript 库，它通过 index.d.ts 定义类型。 我想为 javascript 公开与 typescript 不同的 API。

看起来如果你想从 typescript 中隐藏一些东西，你不能在 .d.ts 文件中定义它。 是否可以反过来做？ 据我所知，.d.ts 文件只能有定义，没有实现。 有没有办法实现 typescript 仅功能 in.d.ts 或其他？

例如，我想公开一个仅用于 js 的通用 get() function，并键入仅为 typescript 定义的 getString 和 getInt 包装器。

index.d.ts

declare module 'example' {
  export function getConfig(): Config;

  export interface Config {
    // have these wrap get() and return null if the type is wrong
    getString(name: string): string | null; 
    getInt(name: string): int | null;
  }
}

index.js

module.exports = {
  getConfig() {
    return new Config({
      testString: "test",
      testInt: 12,
    })
  }
}

Config.js

class Config {
  constructor(configObject) {
    this.configObject = configObject;
  }

  get(index) {
    return this.configObject?[index];
  }
}

Answer 1

这在概念上是不可能的，因为在运行时没有 typescript 。 您的 typescript 编译为 javascript。 这些类型基本上只是被删除了。 也没有办法真正从 typescript 隐藏一些东西。 仅仅因为您没有类型并不能阻止您调用 function。

但是，如果您只想正确输入，则正确的方法是 generics。 所以如果你有一个get() function 你可以这样输入：

function getIt<T extends String | Number>(name: string) : T {
  ...
}

然后你可以像 ts 中的getIt<Number>("...")或 js 中的getIt("...")一样使用它。