如何实现 TypeScript 深度部分映射类型而不破坏数组属性

Question

关于如何将 TypeScript 的 Partial 映射类型递归地应用于接口，同时不破坏任何具有数组返回类型的键的想法？

以下方法还不够：

interface User {  
  emailAddress: string;  
  verification: {
    verified: boolean;
    verificationCode: string;
  }
  activeApps: string[];
}

type PartialUser = Partial<User>; // does not affect properties of verification  

type PartialUser2 = DeepPartial<User>; // breaks activeApps' array return type;

export type DeepPartial<T> = {
  [ P in keyof T ]?: DeepPartial<T[ P ]>;
}

有什么想法吗？

更新： 已接受的答案 - 目前更好、更通用的解决方案。

找到了一种临时解决方法，其中涉及类型和两个映射类型的交集，如下所示。最显着的缺点是您必须提供属性覆盖来恢复被污染的键，即具有数组返回类型的键。

例如

type PartialDeep<T> = {
  [ P in keyof T ]?: PartialDeep<T[ P ]>;
}
type PartialRestoreArrays<K> = {
  [ P in keyof K ]?: K[ P ];
}

export type DeepPartial<T, K> = PartialDeep<T> & PartialRestoreArrays<K>;

interface User {  
 emailAddress: string;  
 verification: {
   verified: boolean;
   verificationCode: string;
 }
 activeApps: string[];
}

export type AddDetailsPartialed = DeepPartial<User, {
 activeApps?: string[];
}>

Like so

Answer 1

使用 TS 2.8 和条件类型，我们可以简单地编写：

type DeepPartial<T> = {
  [P in keyof T]?: T[P] extends Array<infer U>
    ? Array<DeepPartial<U>>
    : T[P] extends ReadonlyArray<infer U>
      ? ReadonlyArray<DeepPartial<U>>
      : DeepPartial<T[P]>
};

或者用[] 代替Array<> 那将是：

type DeepPartial<T> = {
  [P in keyof T]?: T[P] extends (infer U)[]
    ? DeepPartial<U>[]
    : T[P] extends Readonly<infer U>[]
      ? Readonly<DeepPartial<U>>[]
      : DeepPartial<T[P]>
};

您可能需要查看 https://github.com/krzkaczor/ts-essentials 包以了解此类型以及其他一些有用的类型。

Answer 2

我从@krzysztof 的答案开始，但当我遇到极端情况时，我一直在迭代它。特别是下面的边缘情况，基于基础对象的给定值（即T[P]）：

• any
• any[]
• ReadonlyArray<any>
• Map
• Set

type NonAny = number | boolean | string | symbol | null;
type DeepPartial<T> = {
  [P in keyof T]?: T[P] extends NonAny[] // checks for nested any[]
    ? T[P]
    : T[P] extends ReadonlyArray<NonAny> // checks for nested ReadonlyArray<any>
    ? T[P]
    : T[P] extends (infer U)[]
    ? DeepPartial<U>[]
    : T[P] extends ReadonlyArray<infer U>
    ? ReadonlyArray<DeepPartial<U>>
    : T[P] extends Set<infer V> // checks for Sets
    ? Set<DeepPartial<V>>
    : T[P] extends Map<infer K, infer V> // checks for Maps
    ? Map<K, DeepPartial<V>>
    : T[P] extends NonAny // checks for primative values
    ? T[P]
    : DeepPartial<T[P]>; // recurse for all non-array and non-primative values
};

NonAny 类型用于检查 any 值

Answer 3

可以使用ts-toolbelt，可以对任意深度的类型进行操作

在你的情况下，它会是：

import {O} from 'ts-toolbelt'

interface User {  
    emailAddress: string;  
    verification: {
      verified: boolean;
      verificationCode: string;
    }
    activeApps: string[];
}

type optional = O.Optional<User, keyof User, 'deep'>

如果你想深入计算它（用于显示目的），你可以使用Compute

Answer 4

2018 年 6 月 22 日更新：

这个答案是在一年前写的，在惊人的 conditional types 功能在 TypeScript 2.8 中发布之前。所以不再需要这个答案。请参阅下面的@krzysztof-kaczor 的new answer，了解在 TypeScript 2.8 及更高版本中获得此行为的方法。

---

好的，这是我对一个疯狂但完全通用的解决方案（需要 TypeScript 2.4 及更高版本）的最佳尝试，这对你来说可能不值得，但如果你想使用它，请成为我的客人：

首先，我们需要一些类型级别的布尔逻辑：

type False = '0'
type True = '1'
type Bool = False | True
type IfElse<Cond extends Bool, Then, Else> = {'0': Else; '1': Then;}[Cond];

您只需要知道IfElse<True,A,B> 类型的计算结果为A 和IfElse<False,A,B> 的计算结果为B。

现在我们定义一个记录类型Rec<K,V,X>，一个具有键K和值类型V的对象，其中Rec<K,V,True>表示该属性是必需的，Rec<K,V,False>表示属性是可选的：

type Rec<K extends string, V, Required extends Bool> = IfElse<Required, Record<K, V>, Partial<Record<K, V>>>

---

此时我们可以获取您的User 和DeepPartialUser 类型。让我们描述一个通用的UserSchema<R>，其中我们关心的每个属性要么是必需的，要么是可选的，这取决于R 是True 还是False：

type UserSchema<R extends Bool> =
  Rec<'emailAddress', string, R> &
  Rec<'verification', (
    Rec<'verified', boolean, R> &
    Rec<'verificationCode', string, R>
  ), R> &
  Rec<'activeApps', string[], R>

丑陋，对吧？但我们最终可以将User 和DeepPartialUser 描述为：

interface User extends UserSchema<True> { } // required
interface DeepPartialUser extends UserSchema<False> { }  // optional

看看它的实际效果：

var user: User = {
  emailAddress: 'foo@example.com',
  verification: {
    verified: true,
    verificationCode: 'shazam'
  },
  activeApps: ['netflix','facebook','angrybirds']
} // any missing properties or extra will cause an error

var deepPartialUser: DeepPartialUser = {
  emailAddress: 'bar@example.com',
  verification: {
    verified: false
  }
} // missing properties are fine, extra will still error

---

给你。希望对您有所帮助！