fix(types): handling PropType<Function> with default value (#1896)

fix #1891
This commit is contained in:
Carlos Rodrigues 2020-08-19 21:36:42 +01:00 committed by GitHub
parent 02dcc68c24
commit c2913d57d1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 8 additions and 1 deletions

View File

@ -47,7 +47,7 @@ type DefaultFactory<T> = (props: Data) => T | null | undefined
interface PropOptions<T = any, D = T> {
type?: PropType<T> | true | null
required?: boolean
default?: D | DefaultFactory<D> | null | undefined
default?: D | DefaultFactory<D> | null | undefined | object
validator?(value: unknown): boolean
}

View File

@ -30,6 +30,7 @@ describe('with object props', () => {
fff: (a: number, b: string) => { a: boolean }
hhh: boolean
ggg: 'foo' | 'bar'
ffff: (a: number, b: string) => { a: boolean }
validated?: string
}
@ -90,6 +91,11 @@ describe('with object props', () => {
type: String as PropType<'foo' | 'bar'>,
default: 'foo'
},
// default + function
ffff: {
type: Function as PropType<(a: number, b: string) => { a: boolean }>,
default: (a: number, b: string) => ({ a: true })
},
validated: {
type: String,
// validator requires explicit annotation
@ -113,6 +119,7 @@ describe('with object props', () => {
expectType<ExpectedProps['fff']>(props.fff)
expectType<ExpectedProps['hhh']>(props.hhh)
expectType<ExpectedProps['ggg']>(props.ggg)
expectType<ExpectedProps['ffff']>(props.ffff)
expectType<ExpectedProps['validated']>(props.validated)
// @ts-expect-error props should be readonly