Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 23 additions & 1 deletion packages-private/dts-test/defineComponent.test-d.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -1364,6 +1364,29 @@ describe('function syntax w/ generics', () => {
// @ts-expect-error generics don't match
<Comp msg={123} list={['123']} />,
)

const CompWithProps = defineComponent(
<T extends string | number>(props: { msg: T; list: T[] }) => {
const count = ref(0)
return () => (
<div>
{props.msg} {count.value}
</div>
)
},
{ props: ['msg', 'list'] },
)

expectType<JSX.Element>(<CompWithProps msg="hello" list={['world']} />)
expectType<JSX.Element>(<CompWithProps msg={123} list={[456]} />)

expectType<JSX.Element>(
// @ts-expect-error missing prop
<CompWithProps msg={123} />,
)

expectType<JSX.Element>(<CompWithProps msg="hello" list={[123]} />)
expectType<JSX.Element>(<CompWithProps msg={123} list={['hello']} />)
})

describe('function syntax w/ emits', () => {
Expand Down Expand Up @@ -1431,7 +1454,6 @@ describe('function syntax w/ runtime props', () => {
},
)

// @ts-expect-error string prop names don't match
defineComponent(
(_props: { msg: string }) => {
return () => {}
Expand Down
19 changes: 19 additions & 0 deletions packages/runtime-core/src/apiDefineComponent.ts
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,25 @@ export function defineComponent<
},
): DefineSetupFnComponent<Props, E, S>

// overload for generic setup functions with props option
export function defineComponent<
F extends (props: any, ctx?: SetupContext<any, any>) => any,
E extends EmitsOptions = {},
EE extends string = string,
S extends SlotsType = {},
>(
setup: F,
options?: Pick<ComponentOptions, 'name' | 'inheritAttrs'> & {
props?: string[]
emits?: E | EE[]
slots?: S
},
): F extends (props: infer P, ...args: any[]) => any
? P extends Record<string, any>
? DefineSetupFnComponent<P, E, S>
: never
: never

// overload 2: defineComponent with options object, infer props from options
export function defineComponent<
// props
Expand Down