TypeScript：从类型/减法类型中删除键

Question

我想定义一个通用型ExcludeCart<T>基本上是T ，但是与给定键（在我的情况下， cart移除）。 因此，例如， ExcludeCart<{foo: number, bar: string, cart: number}>将是{foo: number, bar: string} 。 有没有办法在 TypeScript 中做到这一点？

这就是我要这样做的原因，以防万一我找错了树：我正在将现有的 JavaScript 代码库转换为 TypeScript，其中包含一个名为cartify的装饰器函数，该函数采用 React 组件类Inner并返回另一个组件类Wrapper .

Inner应该带一个cart道具，以及零个或多个其他道具。 Wrapper接受cartClient支柱（其被用于生成cart支柱传递到Inner ），并且任何支柱Inner接受，除了cart 。

换句话说，一旦我弄清楚如何定义ExcludeCart ，我就想用它来做到这一点：

function cartify<P extends {cart: any}>(Inner: ComponentClass<P>) : ComponentClass<ExcludeCart<P> & {cartClient: any}>

Answer 1

TypeScript 3.5 更新： Omit<Type, Keys>实用程序类型现在可用。 有关示例用法，请参阅Mathias 的回答。

---

旧答案：自从TypeScript 2.8和Exclude的引入，现在可以这样写：

type Without<T, K> = {
    [L in Exclude<keyof T, K>]: T[L]
};

或者，更简洁地说，如：

type Without<T, K> = Pick<T, Exclude<keyof T, K>>;

为了您的使用，您现在可以编写以下内容：

type ExcludeCart<T> = Without<T, "cart">;

Answer 2

虽然这已经得到正确回答，但我想指出TypeScript 3.5确实添加了一个Omit<T, E>类型。

type NoCart = Omit<{foo: string, bar: string, cart: number}, "cart">;

这导致{foo: string, bar: string}类型。

Answer 3

虽然没有内置的减法类型，但您目前可以将其修改为：

type Sub0<
    O extends string,
    D extends string,
> = {[K in O]: (Record<D, never> & Record<string, K>)[K]}

type Sub<
    O extends string,
    D extends string,
    // issue 16018
    Foo extends Sub0<O, D> = Sub0<O, D>
> = Foo[O]

type Omit<
    O,
    D extends string,
    // issue 16018
    Foo extends Sub0<keyof O, D> = Sub0<keyof O, D>
> = Pick<O, Foo[keyof O]>

在问题的情况下，你会这样做：

type ExcludeCart<T> = Omit<T, 'cart'>

使用 TypeScript >= 2.6，您可以将其简化为：

/**
 * for literal unions
 * @example Sub<'Y' | 'X', 'X'> // === 'Y'
 */
export type Sub<
    O extends string,
    D extends string
    > = {[K in O]: (Record<D, never> & Record<string, K>)[K]}[O]

/**
 * Remove the keys represented by the string union type D from the object type O.
 *
 * @example Omit<{a: number, b: string}, 'a'> // === {b: string}
 * @example Omit<{a: number, b: string}, keyof {a: number}> // === {b: string}
 */
export type Omit<O, D extends string> = Pick<O, Sub<keyof O, D>>

在操场上测试一下

Answer 4

还有另一种非常简单的方法可以得到这个结果

在打字稿中组合类型时，“从不”类型对所有内容都有更高的优先级。

您可以简单地创建一个类型：

type noCart<T> = T & {cart : never}

或者，不创建类型

function removeCart<T>(obj : T) : T & {cart : never} {
    if("cart" in obj) {
        delete (obj as T & {cart : any}).cart;
    }
    return <T & {cart : never}> obj;
}

这不像 Adrian 的解决方案那么通用，但是当我们不需要复杂性时会更简单一些。

Answer 5

更新：有关此问题的解决方案，请参阅上面阿德里安的回答。 我把我的答案留在这里，因为它仍然包含一些有用的链接。

---

对此功能有各种旧要求（ “外部”类型、减法类型），但没有一个真正取得进展。

最近，随着映射类型的添加，我再次询问了这个问题，Anders 说虽然没有计划制作通用减法类型 operator ，但可能会实现一个更有限的版本，大概看起来像这个提案。

在使用 React 时，我个人遇到了与您非常相似的情况，不幸的是，还没有找到任何好的解决方案。 在一个简单的情况下，您可以使用以下方法：

interface BaseProps {
    foo: number;
    bar: number;
}

interface Inner extends BaseProps {
    cart: Cart;
}

interface Wrapper extends BaseProps {
    cartClient: Client;
}

但我几乎发现这是对extends关键字的语义滥用。 当然，如果您不控制Inner或BaseProps ，那么这将行不通。

Answer 6

因此，例如， ExcludeCart<{foo: number, bar: string, cart: number}> 将是 {foo: number, bar: string}

您可以使用Exclude语法直接执行此操作：

Exclude<{foo: number, bar: string, cart: number}, { cart: number}>