模板字面类型等效

Question

我有一个像这样的枚举：

export enum ApiFunctions {
  "setHidden" = "HIDE",
  "setReadOnly" = "SET_READ_ONLY",
  "setVisible" = "SHOW",
  "setDescription" = "SET_DESCRIPTION",
  "setName" = "SET_NAME",
  "makeRequest" = "MAKE_REQUEST"
}

今天早些时候，我从此枚举中创建了一种新类型：

export type ApiActions = Exclude<`${ApiFunctions}`, "MAKE_REQUEST">

类型返回键的所有值，除了“ make_request”（set_description，....）。

此 TS 4.1和当前的Bundler的TS版本为3.9.7，由于外部提供，我无法真正对其进行更新。

我尝试通过执行以下操作来复制此类型：

export type Something = Exclude<typeof ApiFunctions[keyof typeof ApiFunctions], "MAKE_REQUEST">

但是这种类型而不是给我每个键 set_name |的实际字符串值| set_description ... 在 apiftunctions.setname的行中给我一些东西| apiftunctions.setDescription ...

是否有一种方法可以以其他方式实现模板文字创建的类型完全相同？

Answer 1

不，在打字稿4.1之前，没有程序化方法可以扩展 types 对相应的字符串字面类型。

---

但是，您可能不想做这样的事情（即使使用Typescript 4.1及以上），并且可能有更好的方法。 TypeScript enum s最适合其值 opaque 到您的打字稿代码库的情况。因此，除了 enum 定义本身之外，您的代码不应关心其特定值。您应该访问这些值的唯一方法是通过枚举。因此，始终 apiftunctions.sethiddend ，从不“ hide” 。

这意味着您应该能够更改thexcript代码内部的值，并且不应破坏。当然，如果这些值对某些外部系统（例如API）很重要，那么与该系统的通信将不再起作用。但是相反，如果外部系统更改，以便它想要“隐藏” 而不是“ hide” ，那么您唯一必须在TS代码中更改的是 sethidden =“隐藏” ;您不需要进行“ hide” 字符串字面的全局查找，并使用“隐藏” 文字。

毕竟，如您所见，编译器并不容易参考枚举的字面价值。它的观点是， apiftunctions.sethiddend 是比“ hide” 更具体，因此您不能使用类型“ hide” ，其中需要类型 apiftiftions.SETHIDDER 的值。与编译器与编译器作斗争是为了获得可疑利益而付出了很多努力。如果可能的话，让枚举保持枚举。

考虑到这一点，我对 apiactions 的建议将是：

export enum ApiFunctions {
  setHidden = "HIDE",
  setReadOnly = "SET_READ_ONLY",
  setVisible = "SHOW",
  setDescription = "SET_DESCRIPTION",
  setName = "SET_NAME",
  makeRequest = "MAKE_REQUEST"
}

export type ApiActions = Exclude<ApiFunctions, ApiFunctions.makeRequest>;
/* type ApiActions = ApiFunctions.setHidden | ApiFunctions.setReadOnly | 
     ApiFunctions.setVisible | ApiFunctions.setDescription | ApiFunctions.setName */

---

另一方面，如果您的打字稿代码真的确实关心 可能不适合您的用例。由于Typescript 3.4引入断言，获得类似枚举的对象。看起来这样：

export const ApiFunctions = {
  setHidden: "HIDE",
  setReadOnly: "SET_READ_ONLY",
  setVisible: "SHOW",
  setDescription: "SET_DESCRIPTION",
  setName: "SET_NAME",
  makeRequest: "MAKE_REQUEST"
} as const;

由此可以通过编程方式制作也称为 apiftunctions ：

export type ApiFunctions =
  typeof ApiFunctions[keyof typeof ApiFunctions];

这两个定义与 apiftunctions 的枚举版本相似，除了现在编译器让您通过枚举参考值作为字面类型：

export type ApiActions = Exclude<ApiFunctions, "MAKE_REQUEST">;
/* type ApiActions = "SET_NAME" | "HIDE" | "SET_READ_ONLY" | "SHOW" | "SET_DESCRIPTION" */

---

哪种方法（如果有的话）对您有利，取决于您的用例。我倾向于避免 Enum 在任何地方都完全避免，因为它们不属于JavaScript，并且具有令人惊讶的行为（尤其是数字枚举）。但这是个人偏爱。

Playground link to code