为Typescript Record定义可选键列表

Question

我想输入一个只能有'a','b'或'c'键的对象.

所以我可以这样做:

Interface IList {
    a?: string;
    b?: string;
    c?: string;
}

它们都是可选的!现在我想知道这是否只能用Record一行编写

type List = Record<'a' | 'b' | 'c', string>;

唯一的问题是需要定义所有密钥.所以我结束了

type List = Partial<Record<'a' | 'b' | 'c', string>>;

这是有效的,但我可以想象有一个更好的方法来做到这一点没有偏见.还有另一种方法可以在Record中使键可选吗？

Answer 1

您可以创建您的List类型的部分版本：

type PartialList = Partial<List>;

如果您不想要中间类型，则可以在一行中完成所有操作：

type PartialList = Partial<Record<'a' | 'b' | 'c', string>>;

最后，您可能会决定，对未来的自己最具表现力的是：

type List = {
    a?: string;
    b?: string;
    c?: string;
}

Answer 2

没有办法指定成员的可选性Record.根据定义,它们是必需的

type Record<K extends keyof any, T> = {
    [P in K]: T; // Mapped properties are not optional, and it's not a homomorphic mapped type so it can't come from anywhere else.
};

如果这是您的常见方案,您可以定义自己的类型:

type PartialRecord<K extends keyof any, T> = {
  [P in K]?: T;
};
type List =  PartialRecord<'a' | 'b' | 'c', string>

或者您也可以PartialRecord使用预定义的映射类型进行定义:

type PartialRecord<K extends keyof any, T> =  Partial<Record<K, T>>

Answer 3

也可以这样做：

type List = { [P in 'a' | 'b' | 'c']?: string }; // The `?` makes the keys optional

例子：

const validList1: List = {
  a: 'hi'
}

const validList2: List = {
  b: 'hi',
  c: 'there'
}

const validList3: List = {
  a: 'oh',
  b: 'hi',
  c: 'there'
}

Answer 4

除了解决方案之外Partial<Record<List, string>>，也许还有一个更明显的选择需要考虑。

相反，您可以将数据存储在地图中。

const map: Map<KeyType, ValueType> = new Map();

从功能角度来看，没有太大区别。这实际上取决于具体情况，这是否是一个可行的替代方案。

Answer 5

看起来在新版本的打字稿中，您可以执行以下操作

type YourUnion = 'a' | 'b' | 'c';   
type ObjectWithOptionalKeys = Partial<Record<YourUnion, string>>
const someObject: ObjectWithOptionalKeys {
  a: 'str', // works
  b: 1 // throws
}
// c may not be specified at all