Merge pull request #124 from cexbrayat/chore/shallow-mount-overloads

chore: shallowMount overloads

Author: lmiller1990

src/mount.ts

@@ -259,9 +259,6 @@ export function mount(
   return createWrapper(app, App, setProps)
 }
 
-export function shallowMount(
-  originalComponent,
-  options?: MountingOptions<any>
-) {
-  return mount(originalComponent, { ...options, shallow: true })
+export const shallowMount: typeof mount = (component: any, options?: any) => {
+  return mount(component, { ...options, shallow: true })
 }

test-dts/shallowMount.d-test.ts

@@ -0,0 +1,101 @@
+import { expectError, expectType } from 'tsd'
+import { defineComponent } from 'vue'
+import { shallowMount } from '../src'
+
+const AppWithDefine = defineComponent({
+  props: {
+    a: {
+      type: String,
+      required: true
+    },
+    b: Number
+  },
+  template: ''
+})
+
+// accept props
+let wrapper = shallowMount(AppWithDefine, {
+  props: { a: 'Hello', b: 2 }
+})
+// vm is properly typed
+expectType<string>(wrapper.vm.a)
+
+// can receive extra props
+// ideally, it should not
+// but the props have type { a: string } & VNodeProps
+// which allows any property
+shallowMount(AppWithDefine, {
+  props: { a: 'Hello', c: 2 }
+})
+
+// wrong prop type should not compile
+expectError(
+  shallowMount(AppWithDefine, {
+    props: { a: 2 }
+  })
+)
+
+const AppWithProps = {
+  props: {
+    a: {
+      type: String,
+      required: true
+    }
+  },
+  template: ''
+}
+
+// accept props
+wrapper = shallowMount(AppWithProps, {
+  props: { a: 'Hello' }
+})
+// vm is properly typed
+expectType<string>(wrapper.vm.a)
+
+// can't receive extra props
+expectError(
+  shallowMount(AppWithProps, {
+    props: { a: 'Hello', b: 2 }
+  })
+)
+
+// wrong prop type should not compile
+expectError(
+  shallowMount(AppWithProps, {
+    props: { a: 2 }
+  })
+)
+
+const AppWithArrayProps = {
+  props: ['a'],
+  template: ''
+}
+
+// accept props
+wrapper = shallowMount(AppWithArrayProps, {
+  props: { a: 'Hello' }
+})
+// vm is properly typed
+expectType<string>(wrapper.vm.a)
+
+// can receive extra props
+// as they are declared as `string[]`
+shallowMount(AppWithArrayProps, {
+  props: { a: 'Hello', b: 2 }
+})
+
+const AppWithoutProps = {
+  template: ''
+}
+
+// can't receive extra props
+expectError(
+  (wrapper = shallowMount(AppWithoutProps, {
+    props: { b: 'Hello' }
+  }))
+)
+
+// except if explicitly cast
+shallowMount(AppWithoutProps, {
+  props: { b: 'Hello' } as never
+})