Browse Source

feat(sfc): support more ergnomic defineEmits type syntax (#7992)

pull/7993/head
Evan You 2 years ago
committed by GitHub
parent
commit
8876dccf42
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 19
      packages/dts-test/setupHelpers.test-d.ts
  2. 20
      packages/runtime-core/src/apiSetupHelpers.ts

19
packages/dts-test/setupHelpers.test-d.ts

@ -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: () => {},

20
packages/runtime-core/src/apiSetupHelpers.ts

@ -1,4 +1,10 @@
import { isArray, isPromise, isFunction, Prettify } from '@vue/shared'
import {
isArray,
isPromise,
isFunction,
Prettify,
UnionToIntersection
} from '@vue/shared'
import {
getCurrentInstance,
setCurrentInstance,
@ -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__) {
@ -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

Loading…
Cancel
Save