如何断言两个接口在 TypeScript 中包含相同的键？

Question

给定接口Foo 和Bar，我如何静态地断言这两种类型具有相同的键？

背景：我有一个接口，它既需要用作数据库 DTO，又需要用作“模型”类型。对于数据库 DTO，原语将是常规的 JavaScript 原语。对于“模型”类型，原语将是标称类型（例如 AccountId 而不是 string 等）。目前，我通过定义 2 个接口来实现这一点：一个用于 DTO，一个用于模型。但是，我想要一些方法来确保这些接口不会漂移：

interface Dto {
  orderId: string;
  invoiceNo: number;
}
interface Model {
  orderId: OrderId;
  invoiceNo: InvoiceNumber;
}
assertKeysEqual<Dto, Model>() // Compiles OK

interface Dto {
  orderId: string;
  invoiceNo: number;
  x: any;
}
interface Model {
  orderId: OrderId;
  invoiceNo: InvoiceNumber;
}
assertKeysEqual<Dto, Model>() // Compile ERROR ('Model' does not contain 'x')

interface Dto {
  orderId: string;
  invoiceNo: number;
}
interface Model {
  orderId: OrderId;
  invoiceNo: InvoiceNumber;
  x: any;
}
assertKeysEqual<Dto, Model>() // Compile ERROR ('Dto' does not contain 'x')

名义类型使用以下方法定义。 但是，更一般地说：键类型的形状可能在类型之间完全不同。例如，在一种类型中，您可能有 order: OrderId，它可以在其“扩展”对应类型中替换为 order: OrderEntity。

export interface OrderId extends String {
  _OrderId: string;
}
export function OrderId(value: string): OrderId {
  return value as any;
}

知道如何实现assertKeysEqual 之类的东西吗？

Answer 1

还有一个仅类型的解决方案，它会给出一些可读的错误消息：

type AssertKeysEqual<
  T1 extends Record<keyof T2, any>,
  T2 extends Record<keyof T1, any>
> = never

type Assertion = AssertKeysEqual<{a:1}, {a:1, b: 'x'}>
// ERROR: Property 'b' is missing in type '{ a: 1; }' but required in type 'Record<"a" | "b", any>'.

TypeScript playground

更新：在 TypeScript 4.2+ 中，类型别名保留 (docs) 允许稍微更愉快的错误消息，如果您引入额外的类型 ShapeOf 进行记录：

type ShapeOf<T> = Record<keyof T, any>
type AssertKeysEqual<X extends ShapeOf<Y>, Y extends ShapeOf<X>> = never

type Assertion = AssertKeysEqual<{a:1}, {a:1, b: 'x'}>
// ERROR: Property 'b' is missing in type '{ a: 1; }' but required in 
// type 'ShapeOf<{ a: 1; b: "x"; }>'.

TypeScript playground

Answer 2

您可以检查每个接口的键是否是另一个的子集：

type AssertEqualKeys<T1 extends object, T2 extends object> =
  [
    keyof T1 extends keyof T2 ? 1 : 0,
    keyof T2 extends keyof T1 ? 1 : 0
  ] extends [1,1] ?  true : false;

const areEqual: AssertEqualKeys<Dto,Model> = true;

如果密钥相互偏离，该类型将解析为 false，并且您会收到错误通知。

playground link