typescript - 将通用 typescript 类型限制为单个字符串文字值，不允许联合

Question

我有一个泛型实体类型，该泛型用于根据一组字符串文字定义字段类型:

type EntityTypes = 'foo' | 'bar' | 'baz';

type EntityMappings = {
  foo: string;
  bar: number;
  baz: Array<string>;
}

type GenericEntity<T extends EntityTypes> = {
  type: T;
  fieldProperty: EntityMappings[T];
}

我想要做的是要求 GenericEntity 的所有实例都有一个 type然后定义 fieldProperty 类型的字段(字符串文字)，例如:

const instance: GenericEntity<'foo'> = {
  type: 'foo',
  fieldProperty: 'hello',
};

const otherInstance: GenericEntity<'baz'> = {
  type: 'baz',
  fieldProperty: ['a', 'b', 'c'],
}

但是，因为T extends EntityTypes允许在 EntityTypes 中合并多个字符串文字值，我能够做到这一点，但我想禁止这样做:

const badInstance: GenericEntity<'foo' | 'baz'> = {
  type: 'baz',
  fieldProperty: 'blah',
};

编译是因为现在 type类型为 'foo' | 'baz' fieldProperty 的类型是 string | Array<string> , 但是这两个字段不再像我预期的那样对应。

有没有办法进一步限制 GenericEntity 上的泛型声明，只允许一个唯一的字符串文字值？除此之外，是否有其他方法可以坚持 GenericEntity 的任何实例都具有 type场和一个fieldProperty对应的字段？

Answer 1

目前没有直接的方法来限制 generic union 的单个成员的类型参数.在 microsoft/TypeScript#27808 有一个开放的功能请求支持类似 T extends <em>oneof</em> EntityTyes 的东西, 但尚未实现。如果你想看到它发生，你可以访问那个问题并给它一个 👍，但我不知道它会有多大影响。

这意味着 T extends EntityTypes可以允许 T是 EntityTypes 的任何子类型，包括完整的 EntityTypes联盟。在实践中，这往往不是什么大问题，因为通常这样 T确实被推断为单个成员(人们经常调用 foo("x") 或 foo("y") 而不是 foo(Math.random()<0.5?"x":"y") )。但有时它会导致问题，尤其是像您这样的示例代码。

---

那么我们如何解决这个问题呢？鉴于您的特定示例代码，我会说您想要 GenericEntity实际上更像是一个具有三个成员的可区分联合，而不是一个通用类型。但是您可以通过 microsoft/TypeScript#47109 中创造的分布式对象类型 获得两者。 .它看起来像这样:

type GenericEntity<T extends EntityTypes = EntityTypes> = { [U in T]: {
  type: U;
  fieldProperty: EntityMappings[U];
} }[T]

我们正在使用类型 T传入并mapping over它的成员，然后是indexing into it与 T .如果 T 这没有实际效果是单个字符串文字，但当它是一个联合时，结果也是一个没有任何不需要的“交叉相关”项的联合:

type GE = GenericEntity;
/* type GE = {
    type: "foo";
    fieldProperty: string;
} | {
    type: "bar";
    fieldProperty: number;
} | {
    type: "baz";
    fieldProperty: string[];
} */

(我还为 T 创建了一个 generic parameter default，所以没有类型参数的 GenericEntity 是我们真正想要的完整联合。)

所以我们正在做的是:而不是禁止 T 中的联合，我们通过分发它们来处理它们。

现在事情会如你所愿:

const instance: GenericEntity<'foo'> = {
  type: 'foo',
  fieldProperty: 'hello',
} // okay;

const otherInstance: GenericEntity<'baz'> = {
  type: 'baz',
  fieldProperty: ['a', 'b', 'c'],
} // okay

const badInstance: GenericEntity<'foo' | 'baz'> = {
  type: 'baz',
  fieldProperty: 'blah',
}; // error!

看起来不错!

Playground link to code