types(props): Support undefined as default (#3783)

This commit is contained in:
Carlos Rodrigues 2021-05-17 19:04:31 +01:00 committed by GitHub
parent 47da92146c
commit 92e7330385
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 13 additions and 1 deletions

View File

@ -76,7 +76,7 @@ type RequiredKeys<T> = {
// don't mark Boolean props as undefined
| BooleanConstructor
| { type: BooleanConstructor }
? K
? T[K] extends { default: undefined | (() => undefined) } ? never : K
: never
}[keyof T]

View File

@ -23,6 +23,8 @@ describe('with object props', () => {
h: boolean
bb: string
bbb: string
bbbb: string | undefined
bbbbb: string | undefined
cc?: string[] | undefined
dd: { n: 1 }
ee?: () => string
@ -62,6 +64,14 @@ describe('with object props', () => {
// annotation
default: (props: any) => (props.bb as string) || 'foo'
},
bbbb: {
type: String,
default: undefined
},
bbbbb: {
type: String,
default: () => undefined
},
// explicit type casting
cc: Array as PropType<string[]>,
// required + type casting
@ -129,6 +139,8 @@ describe('with object props', () => {
expectType<ExpectedProps['h']>(props.h)
expectType<ExpectedProps['bb']>(props.bb)
expectType<ExpectedProps['bbb']>(props.bbb)
expectType<ExpectedProps['bbbb']>(props.bbbb)
expectType<ExpectedProps['bbbbb']>(props.bbbbb)
expectType<ExpectedProps['cc']>(props.cc)
expectType<ExpectedProps['dd']>(props.dd)
expectType<ExpectedProps['ee']>(props.ee)