fix(types): emit type in SetupContext (#884)

vuejs · Jan 16, 2022 · 5c35403 · 5c35403
1 parent 315f6ab
commit 5c35403
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 6 deletions.
diff --git a/src/component/componentOptions.ts b/src/component/componentOptions.ts
@@ -22,10 +22,14 @@ export interface MethodOptions {
   [key: string]: Function
 }
 
-export type SetupFunction<Props, RawBindings = {}> = (
+export type SetupFunction<
+  Props,
+  RawBindings = {},
+  Emits extends EmitsOptions = {}
+> = (
   this: void,
   props: Readonly<Props>,
-  ctx: SetupContext
+  ctx: SetupContext<Emits>
 ) => RawBindings | (() => VNode | null) | void
 
 interface ComponentOptionsBase<
@@ -70,7 +74,7 @@ export type ComponentOptionsWithProps<
 > = ComponentOptionsBase<Props, D, C, M> & {
   props?: PropsOptions
   emits?: Emits & ThisType<void>
-  setup?: SetupFunction<Props, RawBindings>
+  setup?: SetupFunction<Props, RawBindings, Emits>
 } & ThisType<
     ComponentRenderProxy<Props, RawBindings, D, C, M, Mixin, Extends, Emits>
   >
@@ -88,7 +92,7 @@ export type ComponentOptionsWithArrayProps<
 > = ComponentOptionsBase<Props, D, C, M> & {
   props?: PropNames[]
   emits?: Emits & ThisType<void>
-  setup?: SetupFunction<Props, RawBindings>
+  setup?: SetupFunction<Props, RawBindings, Emits>
 } & ThisType<
     ComponentRenderProxy<Props, RawBindings, D, C, M, Mixin, Extends, Emits>
   >
@@ -105,7 +109,7 @@ export type ComponentOptionsWithoutProps<
 > = ComponentOptionsBase<Props, D, C, M> & {
   props?: undefined
   emits?: Emits & ThisType<void>
-  setup?: SetupFunction<Props, RawBindings>
+  setup?: SetupFunction<Props, RawBindings, Emits>
 } & ThisType<
     ComponentRenderProxy<Props, RawBindings, D, C, M, Mixin, Extends, Emits>
   >

diff --git a/src/runtimeContext.ts b/src/runtimeContext.ts
@@ -145,7 +145,7 @@ export type ComponentRenderEmitFn<
 
 export type Slots = Readonly<InternalSlots>
 
-export interface SetupContext<E = EmitsOptions> {
+export interface SetupContext<E extends EmitsOptions = {}> {
   attrs: Data
   slots: Slots
   emit: EmitFn<E>

diff --git a/test-dts/defineComponent-vue2.d.tsx b/test-dts/defineComponent-vue2.d.tsx
@@ -14,6 +14,10 @@ describe('emits', () => {
       click: (n: number) => typeof n === 'number',
       input: (b: string) => b.length > 1,
     },
+    setup(props, { emit }) {
+      emit('click', 1)
+      emit('input', 'foo')
+    },
     created() {
       this.$emit('click', 1)
       this.$emit('click', 1).$emit('click', 1)