如何使用映射类型删除索引签名

Question

给定一个接口（来自无法更改的现有 .d.ts 文件）：

interface Foo {
  [key: string]: any;
  bar(): void;
}

有没有办法使用映射类型（或其他方法）在没有索引签名的情况下派生新类型？即它只有方法bar(): void;

Answer 1

编辑： 自 Typescript 4.1 以来，有一种方法可以直接使用 Key Remapping 执行此操作，避免使用 Pick 组合子。请参阅the answer by Oleg where it's introduced。

type RemoveIndex<T> = {
  [ K in keyof T as string extends K ? never : number extends K ? never : K ] : T[K]
};

这是基于'a' extends string 但string 不是extends 'a' 的事实。

---

还有一种方法可以用 TypeScript 2.8 的 Conditional Types 来表达。

interface Foo {
  [key: string]: any;
  [key: number]: any;
  bar(): void;
}

type KnownKeys<T> = {
  [K in keyof T]: string extends K ? never : number extends K ? never : K
} extends { [_ in keyof T]: infer U } ? U : never;


type FooWithOnlyBar = Pick<Foo, KnownKeys<Foo>>;

你可以用它做一个通用的：

// Generic !!!
type RemoveIndex<T extends Record<any,any>> = Pick<T, KnownKeys<T>>;

type FooWithOnlyBar = RemoveIndex<Foo>;

要了解KnownKeys<T> 的确切原因，请参阅以下答案：

https://stackoverflow.com/a/51955852/2115619

Answer 2

使用 TypeScript v4.1 key remapping 带来了一个非常简洁的解决方案。

它的核心使用了来自Mihail's answer 的稍微修改的逻辑：虽然已知键是string 或number 的子类型，但后者不是相应文字的子类型。另一方面，string 是所有可能字符串的联合（number 也是如此），因此是自反的（type res = string extends string ? true : false; //true 成立）。

这意味着每次string 或number 类型可分配给键类型时，您都可以解析为never，从而有效地将其过滤掉：

interface Foo {
  [key: string]: any;
  [key: number]: any;
  bar(): void;
}

type RemoveIndex<T> = {
  [ P in keyof T as string extends P ? never : number extends P ? never : P ] : T[P]
};

type FooWithOnlyBar = RemoveIndex<Foo>; //{ bar: () => void; }

Playground

Answer 3

通过TypeScript 4.4，该语言获得了对更复杂索引签名的支持。

interface FancyIndices {
  [x: symbol]: number;
  [x: `data-${string}`]: string
}

symbol 键可以通过在之前发布的类型中添加一个大小写来轻松捕获，但这种检查方式无法检测到无限的模板文字。¹

但是，我们可以通过修改检查以查看使用每个键构造的对象是否可分配给空对象来实现相同的目标。这是有效的，因为“真实”键将要求使用 Record<K, 1> 构造的对象具有属性，因此不可分配，而作为索引签名的键将导致类型可能仅包含空对象。

type RemoveIndex<T> = {
  [K in keyof T as {} extends Record<K, 1> ? never : K]: T[K]
}

在playground试试吧

测试：

class X {
  [x: string]: any
  [x: number]: any
  [x: symbol]: any
  [x: `head-${string}`]: string
  [x: `${string}-tail`]: string
  [x: `head-${string}-tail`]: string
  [x: `${bigint}`]: string
  [x: `embedded-${number}`]: string

  normal = 123
  optional?: string
}

type RemoveIndex<T> = {
  [K in keyof T as {} extends Record<K, 1> ? never : K]: T[K]
}

type Result = RemoveIndex<X>
//   ^? - { normal: number, optional?: string  }

¹您可以使用一次处理一个字符的递归类型来检测一些无限模板文字，但这不适用于长键。

Answer 4

没有一个真正通用的方法，但是如果你知道你需要哪些属性，那么你可以使用 Pick：

interface Foo {
  [key: string]: any;
  bar(): void;
}

type FooWithOnlyBar = Pick<Foo, 'bar'>;

const abc: FooWithOnlyBar = { bar: () => { } }

abc.notexisting = 5; // error

Answer 5

不是真的。你不能像这样的界面“减去”一些东西。每个成员都是公开的，任何声称实施Foo 的人都必须实施它们。通常，您只能通过extends 或声明合并 扩展接口，但不能从中删除内容。