fix(types): make toRef return correct type(fix vuejs#4732) (vuejs#4734)

caozhong1996 · yyx990803 · web-flow · commit 925bc346fe85 · 2021-10-08T11:57:49.000-04:00
* fix(types): make `toRef` return correct type(fix vuejs#4732) * chore: use correct test Co-authored-by: Evan You <yyx990803@gmail.com>
diff --git a/packages/reactivity/src/ref.ts b/packages/reactivity/src/ref.ts
@@ -65,7 +65,9 @@ export function isRef(r: any): r is Ref {
   return Boolean(r && r.__v_isRef === true)
 }
 
-export function ref<T extends object>(value: T): ToRef<T>
+export function ref<T extends object>(
+  value: T
+): [T] extends [Ref] ? T : Ref<UnwrapRef<T>>
 export function ref<T>(value: T): Ref<UnwrapRef<T>>
 export function ref<T = any>(): Ref<T | undefined>
 export function ref(value?: unknown) {
@@ -212,7 +214,7 @@ class ObjectRefImpl<T extends object, K extends keyof T> {
   }
 }
 
-export type ToRef<T> = [T] extends [Ref] ? T : Ref<UnwrapRef<T>>
+export type ToRef<T> = [T] extends [Ref] ? T : Ref<T>
 export function toRef<T extends object, K extends keyof T>(
   object: T,
   key: K
diff --git a/test-dts/ref.test-d.ts b/test-dts/ref.test-d.ts
@@ -10,6 +10,7 @@ import {
   toRef,
   toRefs,
   ToRefs,
+  shallowReactive,
   watch
 } from './index'
 
@@ -236,3 +237,15 @@ function testUnrefGenerics<T>(p: T | Ref<T>) {
 }
 
 testUnrefGenerics(1)
+
+// #4732
+const baz = shallowReactive({
+  foo: {
+    bar: ref(42)
+  }
+})
+
+const foo = toRef(baz, 'foo')
+
+expectType<Ref<number>>(foo.value.bar)
+expectType<number>(foo.value.bar.value)

Original file line number	Diff line number	Diff line change
`@@ -65,7 +65,9 @@ export function isRef(r: any): r is Ref {`
`65`	`65`	`return Boolean(r && r.__v_isRef === true)`
`66`	`66`	`}`
`67`	`67`
`68`		`-export function ref<T extends object>(value: T): ToRef<T>`
	`68`	`+export function ref<T extends object>(`
	`69`	`+ value: T`
	`70`	`+): [T] extends [Ref] ? T : Ref<UnwrapRef<T>>`
`69`	`71`	`export function ref<T>(value: T): Ref<UnwrapRef<T>>`
`70`	`72`	`export function ref<T = any>(): Ref<T \| undefined>`
`71`	`73`	`export function ref(value?: unknown) {`
`@@ -212,7 +214,7 @@ class ObjectRefImpl<T extends object, K extends keyof T> {`
`212`	`214`	`}`
`213`	`215`	`}`
`214`	`216`
`215`		`-export type ToRef<T> = [T] extends [Ref] ? T : Ref<UnwrapRef<T>>`
	`217`	`+export type ToRef<T> = [T] extends [Ref] ? T : Ref<T>`
`216`	`218`	`export function toRef<T extends object, K extends keyof T>(`
`217`	`219`	`object: T,`
`218`	`220`	`key: K`