Skip to content

Commit

Permalink
feat(sfc): support more ergnomic defineEmits type syntax (#7992)
Browse files Browse the repository at this point in the history
  • Loading branch information
yyx990803 authored Mar 30, 2023
1 parent 8ac0620 commit 8876dcc
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 2 deletions.
19 changes: 19 additions & 0 deletions packages/dts-test/setupHelpers.test-d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,25 @@ describe('defineEmits w/ type declaration', () => {
emit2('baz')
})

describe('defineEmits w/ alt type declaration', () => {
const emit = defineEmits<{
foo: [id: string]
bar: any[]
baz: []
}>()

emit('foo', 'hi')
// @ts-expect-error
emit('foo')

emit('bar')
emit('bar', 1, 2, 3)

emit('baz')
// @ts-expect-error
emit('baz', 1)
})

describe('defineEmits w/ runtime declaration', () => {
const emit = defineEmits({
foo: () => {},
Expand Down
20 changes: 18 additions & 2 deletions packages/runtime-core/src/apiSetupHelpers.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
import { isArray, isPromise, isFunction, Prettify } from '@vue/shared'
import {
isArray,
isPromise,
isFunction,
Prettify,
UnionToIntersection
} from '@vue/shared'
import {
getCurrentInstance,
setCurrentInstance,
Expand Down Expand Up @@ -120,7 +126,9 @@ export function defineEmits<EE extends string = string>(
export function defineEmits<E extends EmitsOptions = EmitsOptions>(
emitOptions: E
): EmitFn<E>
export function defineEmits<TypeEmit>(): TypeEmit
export function defineEmits<
T extends ((...args: any[]) => any) | Record<string, any[]>
>(): T extends (...args: any[]) => any ? T : ShortEmits<T>
// implementation
export function defineEmits() {
if (__DEV__) {
Expand All @@ -129,6 +137,14 @@ export function defineEmits() {
return null as any
}

type RecordToUnion<T extends Record<string, any>> = T[keyof T]

type ShortEmits<T extends Record<string, any>> = UnionToIntersection<
RecordToUnion<{
[K in keyof T]: (evt: K, ...args: T[K]) => void
}>
>

/**
* Vue `<script setup>` compiler macro for declaring a component's exposed
* instance properties when it is accessed by a parent component via template
Expand Down

0 comments on commit 8876dcc

Please sign in to comment.