types(setProps): setProps to Partial props

vuejs · Nov 14, 2023 · f59f8a6 · f59f8a6
1 parent eb4a23a
commit f59f8a6
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 12 deletions.
diff --git a/src/mount.ts b/src/mount.ts
@@ -54,9 +54,7 @@ export function mount<
     ComponentProps<C>,
     ComponentData<C> & ComponentExposed<C> & Omit<P, keyof ComponentProps<C>>
   >
-> & {
-  LOOL: Exclude<P, ComponentProps<C>>
-}
+>
 
 // implementation
 export function mount(

diff --git a/src/vueWrapper.ts b/src/vueWrapper.ts
@@ -244,7 +244,7 @@ export class VueWrapper<
     return nextTick()
   }
 
-  setProps(props: T['$props']): Promise<void> {
+  setProps(props: Partial<T['$props']>): Promise<void> {
     // if this VM's parent is not the root or if setProps does not exist, error out
     if (this.vm.$parent !== this.rootVM || !this.__setProps) {
       throw Error('You can only use setProps on your mounted component')

diff --git a/test-dts/wrapper.d-test.ts b/test-dts/wrapper.d-test.ts
@@ -120,25 +120,49 @@ expectType<{ [key: string]: any }>(wrapper.props())
 const ComponentWithProps = defineComponent({
   props: {
     foo: String,
-    bar: Number,
-  },
+    bar: Number
+  }
 })
 
-const propsWrapper = mount(ComponentWithProps);
+const propsWrapper = mount(ComponentWithProps)
 
-propsWrapper.setProps({foo: 'abc'})
-propsWrapper.setProps({foo: 'abc', bar: 123})
+propsWrapper.setProps({ foo: 'abc' })
+propsWrapper.setProps({ foo: 'abc', bar: 123 })
 // @ts-expect-error :: should require string
-propsWrapper.setProps({foo: 123})
+propsWrapper.setProps({ foo: 123 })
 // @ts-expect-error :: unknown prop
-propsWrapper.setProps({badProp: true})
+propsWrapper.setProps({ badProp: true })
 
 expectType<string | undefined>(propsWrapper.props().foo)
 expectType<number | undefined>(propsWrapper.props().bar)
 // @ts-expect-error :: unknown prop
-propsWrapper.props().badProp;
+propsWrapper.props().badProp
 
 expectType<string | undefined>(propsWrapper.props('foo'))
 expectType<number | undefined>(propsWrapper.props('bar'))
 // @ts-expect-error :: unknown prop
 propsWrapper.props('badProp')
+
+const requiredPropsWrapper = mount(
+  defineComponent({
+    props: {
+      foo: { type: String, required: true },
+      bar: { type: Number, required: true }
+    }
+  }),
+  {
+    props: {
+      foo: 'abc',
+      bar: 123
+    }
+  }
+)
+
+requiredPropsWrapper.setProps({
+  foo: 'abc'
+})
+
+requiredPropsWrapper.setProps({
+  // @ts-expect-error wrong type
+  foo: 1
+})