包含用作接口键的 keyof 的模板文字

Question

给定一个简单的界面：

interface Schedule {
  interval: "month" | "day";
  price: number;
}

我可以构造一个模板文字类型（使用ts4.4）：

type PrefixedScheduleKey = `schedule__${keyof Schedule}`; // "schedule__interval" | "schedule__price"

假设有一些这样的接口，我想合并（基本上展平）它们的前缀、模板文字键以结束：

interface Metadata {
  foo: string;
  bar: string;
  // computed 
  schedule__interval: "month" | "day";
  schedule__price: number;
  ...
}

我应该如何声明这样的接口键？

interface Metadata {
  [key: PrefixedScheduleKey]: any
}

// throws 
// An index signature parameter type cannot be a literal type or generic type. Consider using a mapped object type instead.(1337)

和

interface Metadata {
  [key in `schedule__${keyof Schedule}`]: any 
}

// leads to
// A computed property name must be of type 'string', 'number', 'symbol', or 'any'.(2464)
// Member '[key in `schedule__${keyof' implicitly has an 'any' type.(7008)

这是playground。

顺便说一句，使用type 而不是interface 是suggested on github，但这不起作用，因为我的Metadata 接口已经扩展了另一个接口，但我试图保持示例简单。

Answer 1

这不可能直接在界面上执行，如下所述：Typescript: Mapped types with Interface

到目前为止，在 TypeScript 中（从 2.7.2 版开始），联合类型签名在 不允许使用接口，而是应使用映射类型（如 你正确）。

Docs.

但是，您可以使用任意接口和映射类型之间的交集类型as in the original GitHub issue you mentioned（“将其他成员移动到与交集类型组合的单独对象类型”）来实现这一点。您还可以使用as keyword 有效地内联您的PrefixedScheduleKey 模板文字类型，同时保留您的key 足够长的时间以引用Schedule[key]。没有理由不能对其他带前缀的类型执行相同的操作，无论是在相同的映射元数据类型中，还是在您以后相交的相邻元数据类型中。

interface BareMetadata /* extends ArbitraryType */ {
  foo: string;
  bar: string;
}

type ScheduleMetadata = {
  [key in keyof Schedule as `schedule__${key}`]: Schedule[key];
}

type MergedMetadata = BareMetadata & ScheduleMetadata;

const example: MergedMetadata = {
  foo: "one",
  bar: "two",
  schedule__interval: "month",
  schedule__price: 9.99
};

Playground Link

令我惊讶的是，you can even have the interface extend an object-like type，这可能会帮助您避免显式交集：

interface MergedMetadata extends BareMetadata, ScheduleMetadata {}
// or
interface Metadata extends ScheduleMetadata {
  foo: string;
  bar: string;
}

Playground Link