fix(types/sfc): improve the type inference using withDefaults (#12872)

vuejs · Oct 23, 2023 · 099401e · 099401e
1 parent 67c1d26
commit 099401e
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 4 deletions.
diff --git a/types/test/setup-helpers-test.ts b/types/test/setup-helpers-test.ts
@@ -19,25 +19,35 @@ describe('defineProps w/ type declaration + withDefaults', () => {
       arr?: string[]
       obj?: { x: number }
       fn?: (e: string) => void
-      x?: string
       genStr?: string
+      x?: string
+      y?: string
+      z?: string
     }>(),
     {
       number: 123,
       arr: () => [],
       obj: () => ({ x: 123 }),
       fn: () => {},
-      genStr: () => ''
+      genStr: () => '',
+      y: undefined,
+      z: 'string'
     }
   )
 
   res.number + 1
   res.arr.push('hi')
   res.obj.x
   res.fn('hi')
+  res.genStr.slice()
   // @ts-expect-error
   res.x.slice()
-  res.genStr.slice()
+  // @ts-expect-error
+  res.y.slice()
+
+  expectType<string | undefined>(res.x)
+  expectType<string | undefined>(res.y)
+  expectType<string>(res.z)
 })
 
 describe('defineProps w/ union type declaration + withDefaults', () => {

diff --git a/types/v3-setup-helpers.d.ts b/types/v3-setup-helpers.d.ts
@@ -110,7 +110,11 @@ type InferDefault<P, T> = T extends
   : (props: P) => T
 
 type PropsWithDefaults<Base, Defaults> = Base & {
-  [K in keyof Defaults]: K extends keyof Base ? NotUndefined<Base[K]> : never
+  [K in keyof Defaults]: K extends keyof Base
+    ? Defaults[K] extends undefined
+      ? Base[K]
+      : NotUndefined<Base[K]>
+    : never
 }
 
 /**