Commit a174c29

authored

fix(types): fix shallowRef's return type (#12979)

1 parent f5ef882 commit a174c29Copy full SHA for a174c29

File tree

+30

-8

lines changed

+30

-8

lines changed

Lines changed: 3 additions & 6 deletions

Original file line number	Diff line number	Diff line change
`@@ -40,9 +40,7 @@ export function isRef(r: any): r is Ref {`
`40`	`40`	`return !!(r && (r as Ref).__v_isRef === true)`
`41`	`41`	`}`
`42`	`42`
`43`		`-export function ref<T extends object>(`
`44`		`- value: T`
`45`		`-): [T] extends [Ref] ? T : Ref<UnwrapRef<T>>`
	`43`	`+export function ref<T extends Ref>(value: T): T`
`46`	`44`	`export function ref<T>(value: T): Ref<UnwrapRef<T>>`
`47`	`45`	`export function ref<T = any>(): Ref<T \| undefined>`
`48`	`46`	`export function ref(value?: unknown) {`
`@@ -53,9 +51,8 @@ declare const ShallowRefMarker: unique symbol`
`53`	`51`
`54`	`52`	`export type ShallowRef<T = any> = Ref<T> & { [ShallowRefMarker]?: true }`
`55`	`53`
`56`		`-export function shallowRef<T extends object>(`
`57`		`- value: T`
`58`		`-): T extends Ref ? T : ShallowRef<T>`
	`54`	`+export function shallowRef<T>(value: T \| Ref<T>): Ref<T> \| ShallowRef<T>`
	`55`	`+export function shallowRef<T extends Ref>(value: T): T`
`59`	`56`	`export function shallowRef<T>(value: T): ShallowRef<T>`
`60`	`57`	`export function shallowRef<T = any>(): ShallowRef<T \| undefined>`
`61`	`58`	`export function shallowRef(value?: unknown) {`

Lines changed: 12 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ import {`
`15`	`15`	`set,`
`16`	`16`	`del`
`17`	`17`	`} from '../../index'`
`18`		`-import { describe, expectType } from '../utils'`
	`18`	`+import { IsUnion,describe, expectType } from '../utils'`
`19`	`19`
`20`	`20`	`function plainType(arg: number \| Ref<number>) {`
`21`	`21`	`// ref coercing`
`@@ -385,3 +385,14 @@ describe('set/del', () => {`
`385`	`385`	`// @ts-expect-error`
`386`	`386`	`del([], 'fse', 123)`
`387`	`387`	`})`
	`388`	`+`
	`389`	`+`
	`390`	`+{`
	`391`	`+ //#12978`
	`392`	`+ type Steps = { step: '1' } \| { step: '2' }`
	`393`	`+ const shallowUnionGenParam = shallowRef<Steps>({ step: '1' })`
	`394`	`+ const shallowUnionAsCast = shallowRef({ step: '1' } as Steps)`
	`395`	`+`
	`396`	`+ expectType<IsUnion<typeof shallowUnionGenParam>>(false)`
	`397`	`+ expectType<IsUnion<typeof shallowUnionAsCast>>(false)`
	`398`	`+}`

Lines changed: 15 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { ref, computed, watch } from '../../index'`
	`1`	`+import { ref, computed, watch,shallowRef } from '../../index'`
`2`	`2`	`import { expectType } from '../utils'`
`3`	`3`
`4`	`4`	`const source = ref('foo')`
`@@ -76,3 +76,17 @@ watch([someRef, otherRef], values => {`
`76`	`76`	`// no type error`
`77`	`77`	`console.log(value2.a)`
`78`	`78`	`})`
	`79`	`+`
	`80`	`+{`
	`81`	`+ //#12978`
	`82`	`+ type Steps = { step: '1' } \| { step: '2' }`
	`83`	`+ const shallowUnionGenParam = shallowRef<Steps>({ step: '1' })`
	`84`	`+ const shallowUnionAsCast = shallowRef({ step: '1' } as Steps)`
	`85`	`+`
	`86`	`+ watch(shallowUnionGenParam, value => {`
	`87`	`+ expectType<Steps>(value)`
	`88`	`+ })`
	`89`	`+ watch(shallowUnionAsCast, value => {`
	`90`	`+ expectType<Steps>(value)`
	`91`	`+ })`
	`92`	`+}`

Comments

(0)