时间戳

首页 > 解决方案 > 打字稿：在将可选类型与所需类型合并时创建联合而不是交集

typescript - 打字稿：在将可选类型与所需类型合并时创建联合而不是交集

问题描述

当 optional 和 required 属性通过交集合并时， required 获胜

type A = { who: string }
type B = { who?: string }
// $ExpectType {who:string}
type R = A & B

这可能会导致运行时错误，例如，在处理函数中的默认参数模式时

type Params = {
  who: string
  greeting: string
}

const defaults: Params = {
  greeting: 'Hello',
  who: 'Johny 5',
}

function greeting(params: Partial<Params>){
  // $ExpectType Params
  const merged = {...defaults, ...params}

  return `${merged.greeting.toUpperCase()} ${merged.who} !`
}

// @throws - TypeError: Cannot read property 'toUpperCase' of undefined
greeting({greeting:undefined, who: 'Chuck'})

问题：

正如我所描述的是 TS 编译器的行为方式，问题是，如何创建映射类型，将交集解析为联合

所以像：

type SafeMerge<A,B>=....

// $ExpectType {greeting?: string | undefined, who?: string | undefined }
type Result = SafeMerge<Params, Partial<Params>>

混合类型的示例：

// $ExpectType {one?: number | undefined, two: string, three: boolean }
type Result = SafeMerge<{one: number, two:string}, {one?: number, three: boolean}>

标签： typescriptintersectionunionsmapped-types

解决方案

获得一个合并类型，它是两种类型与每个属性的合并，一种可能性的联合是很简单的。我们可以在两种组成类型的键上使用映射类型：

type SafeMerge<T, U> = {
  [P in keyof T |  keyof U] : 
    | (T extends Partial<Record<P, any>> ? T[P] : never)
    | (U extends Partial<Record<P, any>> ? U[P] : never)
}
type Result = SafeMerge<{one: number, two:string }, {one?: number, three: boolean }>
// Result: 
// type Result = {
//     one: number | undefined;
//     two: string;
//     three: boolean;
// }

玩

上述解决方案的问题是我们失去了键的可选性（也是只读性，这对于这个用例可能不太关心）。同态映射类型保留修饰符，但不幸的是我们不能在这里使用一个，因为我们并不真正适合同态映射类型的任何模式（{ [P in keyof T] : T[P] }或者{[P in K]: T[P] }其中 K 是类型参数K extends keyof T，请参见Here和Here）。

我们可以提取可选键并使用两种映射类型，一种用于任何可选键（在至少一个组成部分中是可选的键），另一种用于必需键：

type OptionalPropertyOf<T> = Exclude<{
  [K in keyof T]: T extends Record<K, T[K]>
    ? never
    : K
}[keyof T], undefined>

type SafeMerge<T, U> = {
  [P in OptionalPropertyOf<T> |  OptionalPropertyOf<U>]?: 
    | (T extends Partial<Record<P, any>> ? T[P] : never)
    | (U extends Partial<Record<P, any>> ? U[P] : never)
} & {
  [P in Exclude<keyof T | keyof U,  OptionalPropertyOf<T> |  OptionalPropertyOf<U>>]: 
    | (T extends Partial<Record<P, any>> ? T[P] : never)
    | (U extends Partial<Record<P, any>> ? U[P] : never)
}

type Result = SafeMerge<{one: number, two:string, three: number}, {one?: number, three: boolean}>
// Result: 
// type Result = {
//     one?: number | undefined;
// } & {
//     two: string;
//     three: number | boolean;
// }

type Id<T> = {} & { [P in keyof T]: T[P] }
type FlattenedResult = Id<SafeMerge<{one: number, two:string, three: number }, {one?: number, three: boolean}>>
// type FlattenedResult = {
//     one?: number | undefined;
//     two: string;
//     three: number | boolean;
// }

玩

可选地，我们可以Id像我在上面的示例中所做的那样使交叉点变平，但这是可选的。

推荐阅读