fix(types): return type of withDefaults should be readonly (#8601)

vuejs · Nov 10, 2023 · f15debc · f15debc
1 parent 46e3374
commit f15debc
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/packages/dts-test/setupHelpers.test-d.ts b/packages/dts-test/setupHelpers.test-d.ts
@@ -110,6 +110,7 @@ describe('defineProps w/ generic type declaration + withDefaults', <T extends
  defineProps<{
  n?: number
  bool?: boolean
+ s?: string
 
  generic1?: T[] | { x: T }
  generic2?: { x: T }
@@ -128,6 +129,10 @@ describe('defineProps w/ generic type declaration + withDefaults', <T extends
  )
 
  res.n + 1
+ // @ts-expect-error should be readonly
+ res.n++
+ // @ts-expect-error should be readonly
+ res.s = ''
 
  expectType<T[] | { x: T }>(res.generic1)
  expectType<{ x: T }>(res.generic2)

diff --git a/packages/runtime-core/src/apiSetupHelpers.ts b/packages/runtime-core/src/apiSetupHelpers.ts
@@ -298,8 +298,8 @@ type PropsWithDefaults<
  T,
  Defaults extends InferDefaults<T>,
  BKeys extends keyof T
-> = Omit<T, keyof Defaults> & {
- [K in keyof Defaults]-?: K extends keyof T
+> = Readonly<Omit<T, keyof Defaults>> & {
+ readonly [K in keyof Defaults]-?: K extends keyof T
  ? Defaults[K] extends undefined
  ? T[K]
  : NotUndefined<T[K]>