映射类型能否使属性可选,但前提是满足条件?
Can mapped types make properties optional, but only if a condition is met?
我正在尝试制作一个映射类型,它采用特定类型的所有属性并使它们成为可选的,但保持所有其他属性不变。我知道在定义映射类型时可以使用 optional 修饰符,如:
type MyPartial<T> = {
[key in keyof T]?: T[key]
}
但我不确定语法是否允许将其与条件相结合。我可以非常接近以下内容:
type OptionalArrays<T> = {
[key in keyof T]: T[key] extends Array<any> ? T[key] | undefined : T[key]
}
interface Example {
foo: string[];
bar: number;
};
type Example2 = OptionalArrays<Example>;
问题是这会导致显式 undefined
s,而不是隐式 undefined
s,所以虽然在这两种情况下它会表现得像我想要的那样:
const value1: Example2 = {
foo: [],
bar: 3,
}
const value2: Example2 = {
foo: undefined,
bar: 3,
}
它会给出一个不需要的错误,即缺少 foo
这个错误:
const value3: Example2 = {
bar: 3,
}
是否可以在映射类型中添加可选修饰符 (?
),但只有在满足特定条件时才可以?
可能有更优雅的方法,但将两个映射类型相交并不太尴尬。一种用于可选属性,另一种用于必需属性。
例如:
type OptionalArrays<T> = {
[key in keyof T as T[key] extends Array<any> ? key : never]?: T[key]
} & {
[key in keyof T as T[key] extends Array<any> ? never : key]: T[key]
}
注意映射类型的关键部分中的 as
。这让您可以转换密钥类型。在这种情况下,如果我们想保留它,我们要么使用实际的密钥,要么如果我们不想保留它,则将其转换为 never
。
或者这个版本可能是相似的,但可以说稍微不那么神秘。
type ArrayKeys<T> = {
[key in keyof T]: T[key] extends Array<any> ? key : never
}[keyof T]
type OptionalArrays<T> =
Omit<T, ArrayKeys<T>> & // get one type without array keys
Partial<Pick<T, ArrayKeys<T>>> // get one type with array keys as optional
我正在尝试制作一个映射类型,它采用特定类型的所有属性并使它们成为可选的,但保持所有其他属性不变。我知道在定义映射类型时可以使用 optional 修饰符,如:
type MyPartial<T> = {
[key in keyof T]?: T[key]
}
但我不确定语法是否允许将其与条件相结合。我可以非常接近以下内容:
type OptionalArrays<T> = {
[key in keyof T]: T[key] extends Array<any> ? T[key] | undefined : T[key]
}
interface Example {
foo: string[];
bar: number;
};
type Example2 = OptionalArrays<Example>;
问题是这会导致显式 undefined
s,而不是隐式 undefined
s,所以虽然在这两种情况下它会表现得像我想要的那样:
const value1: Example2 = {
foo: [],
bar: 3,
}
const value2: Example2 = {
foo: undefined,
bar: 3,
}
它会给出一个不需要的错误,即缺少 foo
这个错误:
const value3: Example2 = {
bar: 3,
}
是否可以在映射类型中添加可选修饰符 (?
),但只有在满足特定条件时才可以?
可能有更优雅的方法,但将两个映射类型相交并不太尴尬。一种用于可选属性,另一种用于必需属性。
例如:
type OptionalArrays<T> = {
[key in keyof T as T[key] extends Array<any> ? key : never]?: T[key]
} & {
[key in keyof T as T[key] extends Array<any> ? never : key]: T[key]
}
注意映射类型的关键部分中的 as
。这让您可以转换密钥类型。在这种情况下,如果我们想保留它,我们要么使用实际的密钥,要么如果我们不想保留它,则将其转换为 never
。
或者这个版本可能是相似的,但可以说稍微不那么神秘。
type ArrayKeys<T> = {
[key in keyof T]: T[key] extends Array<any> ? key : never
}[keyof T]
type OptionalArrays<T> =
Omit<T, ArrayKeys<T>> & // get one type without array keys
Partial<Pick<T, ArrayKeys<T>>> // get one type with array keys as optional