带有可选属性子集的 TypeScript 通用属性

Question

我怎样才能拥有一个通用密钥，其中密钥名称必须是既定选项之一，并且还进行限制，以便在分配其中一个密钥时，不能再分配其他密钥。

例如

interface State {
  key: string;
  location: string;
  ['item_id' | 'item2_id' | 'item3_id']: number; //Example
};

I could only assign one of these three values. 
One of them must be assigned, and only one of them can be assigned to the State.

state = {
  key: '1';
  location: 'description';
  item1_id: 1; 
} // OK

state = {
  key: '1';
  location: 'description';
  item4_id: 1; 
} // Error.

state = {
  key: '1';
  location: 'description';
  item1_id: 1; 
  item2_id: 2; 
} // Error.

Answer 1

假设这确实是您想要的结构（并且您无法重构为更易于 TS 理解的结构），您将希望State最终成为多种类型的联合，每个类型都恰好具有其中一种属性，而其他属性被明确禁止（好吧，最接近的是，如果它们存在，它们必须具有undefined值）。

以编程方式定义这种完全一键联合的一种方法是：

type ExactlyOneKey<K extends PropertyKey, V> = { [P in K]:
    (Record<P, V> & Partial<Record<Exclude<K, P>, never>>) extends infer O ?
    { [Q in keyof O]: O[Q] } : never }[K];

这基本上迭代K每个键并生成一个类型，其中K属性的类型为V ，其他属性是类型never可选属性。 让我们看看它在测试示例中的作用：

type Test = ExactlyOneKey<'a' | 'b' | 'c', boolean>;
/* type Test = {
    a: boolean;
    b?: undefined;
    c?: undefined;
} | {
    b: boolean;
    a?: undefined;
    c?: undefined;
} | {
    c: boolean;
    a?: undefined;
    b?: undefined;
} */

查看该联合的每个元素如何具有一个定义的属性和两个禁止的属性。 现在我们可以定义State 。 这必须是type别名而不是interface因为后者不能是联合：

type State = {
    key: string,
    location: string,
} & ExactlyOneKey<'item1_id' | 'item2_id' | 'item3_id', number>;

让我们看看它如何在您的示例中工作：

state = {
    key: '1',
    location: 'description',
    item1_id: 1,
} // OK

state = {
    key: '1',
    location: 'description',
    item4_id: 1, // error here, unknown key
} // Error.

state = { // error here, not assignable to State
    key: '1',
    location: 'description',
    item1_id: 1,
    item2_id: 2,
} // Error.

在我看来很好。 好的，希望有帮助； 祝你好运！

Playground 链接到代码