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

时间:2017-07-28 11:22:12

标签: typescript recursion partial mapped-types

关于如何以递归方式将TypeScript的部分映射类型应用于接口,同时不破坏任何具有数组返回类型的键的任何想法?

以下方法还不够:

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 ]>;
}

有什么想法吗?

更新: 接受的答案 - 现在更好,更一般的解决方案。

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

E.g。

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

4 个答案:

答案 0 :(得分:45)

使用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]>
};

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

答案 1 :(得分:6)

更新2018-06-22:

这个答案是在一年前写的,之后在TypeScript 2.8中发布了惊人的conditional types功能。所以不再需要这个答案了。有关在TypeScript 2.8及更高版本中获取此行为的方法,请参阅下面的@ krzysztof-kaczor&#39; {<3}}。

好的,这是我尝试疯狂但完全通用的解决方案(需要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>类型评估为AIfElse<False,A,B>评估为B

现在我们定义一个记录类型Rec<K,V,X>,一个键为K且值类型为V的对象,其中Rec<K,V,True>表示该属性为 required Rec<K,V,False>表示该属性是可选

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

此时我们可以使用您的UserDeepPartialUser类型。让我们来描述一般UserSchema<R>,其中我们关心的每个属性都是必需的或可选的,具体取决于RTrue还是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>

丑陋,对吗?但我们最终可以将UserDeepPartialUser描述为:

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

你去吧。希望有所帮助!

答案 2 :(得分:1)

您可以使用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

答案 3 :(得分:1)

我从@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的值