fix(types): fix ref macro types

fix #4499
This commit is contained in:
Evan You
2021-09-04 16:42:39 -04:00
parent 5852cc8d82
commit 815bfcffae
4 changed files with 99 additions and 28 deletions

View File

@@ -4,8 +4,11 @@ import { isFunction, NOOP } from '@vue/shared'
import { ReactiveFlags, toRaw } from './reactive'
import { Dep } from './dep'
declare const ComoutedRefSymbol: unique symbol
export interface ComputedRef<T = any> extends WritableComputedRef<T> {
readonly value: T
[ComoutedRefSymbol]: true
}
export interface WritableComputedRef<T> extends Ref<T> {

View File

@@ -251,7 +251,8 @@ export interface RefUnwrapBailTypes {}
export type ShallowUnwrapRef<T> = {
[K in keyof T]: T[K] extends Ref<infer V>
? V
: T[K] extends Ref<infer V> | undefined // if `V` is `unknown` that means it does not extend `Ref` and is undefined
: // if `V` is `unknown` that means it does not extend `Ref` and is undefined
T[K] extends Ref<infer V> | undefined
? unknown extends V
? undefined
: V | undefined

View File

@@ -4,18 +4,30 @@ import {
ComputedRef,
WritableComputedOptions,
DebuggerOptions,
WritableComputedRef,
ShallowUnwrapRef
WritableComputedRef
} from '@vue/runtime-dom'
declare const RefMarker: unique symbol
type RefValue<T> = T & { [RefMarker]?: any }
declare const RefType: unique symbol
declare const ComputedRefMarker: unique symbol
type ComputedRefValue<T> = T & { [ComputedRefMarker]?: any }
declare const enum RefTypes {
Ref = 1,
ComputedRef = 2,
WritableComputedRef = 3
}
declare const WritableComputedRefMarker: unique symbol
type WritableComputedRefValue<T> = T & { [WritableComputedRefMarker]?: any }
type RefValue<T> = T extends null | undefined
? T
: T & { [RefType]?: RefTypes.Ref }
type ComputedRefValue<T> = T extends null | undefined
? T
: T & { [RefType]?: RefTypes.ComputedRef }
type WritableComputedRefValue<T> = T extends null | undefined
? T
: T & { [RefType]?: RefTypes.WritableComputedRef }
type NormalObject<T extends object> = T & { [RefType]?: never }
/**
* Vue ref transform macro for binding refs as reactive variables.
@@ -23,25 +35,35 @@ type WritableComputedRefValue<T> = T & { [WritableComputedRefMarker]?: any }
declare function _$<T>(arg: ComputedRef<T>): ComputedRefValue<T>
declare function _$<T>(arg: WritableComputedRef<T>): WritableComputedRefValue<T>
declare function _$<T>(arg: Ref<T>): RefValue<T>
declare function _$<T extends object>(arg?: T): ShallowUnwrapRef<T>
declare function _$<T extends object>(arg?: T): DestructureRefs<T>
type DestructureRefs<T extends object> = {
[K in keyof T]: T[K] extends ComputedRef<infer V>
? ComputedRefValue<V>
: T[K] extends WritableComputedRef<infer V>
? WritableComputedRefValue<V>
: T[K] extends Ref<infer V>
? RefValue<V>
: T[K]
}
/**
* Vue ref transform macro for accessing underlying refs of reactive varaibles.
*/
declare function _$$<T extends object>(arg: NormalObject<T>): ToRawRefs<T>
declare function _$$<T>(value: RefValue<T>): Ref<T>
declare function _$$<T>(value: ComputedRefValue<T>): ComputedRef<T>
declare function _$$<T>(
value: WritableComputedRefValue<T>
): WritableComputedRef<T>
declare function _$$<T>(value: RefValue<T>): Ref<T>
declare function _$$<T extends object>(arg: T): ToRawRefs<T>
type ToRawRefs<T extends object> = {
[K in keyof T]: T[K] extends ComputedRefValue<infer V>
? ComputedRefValue<V>
[K in keyof T]: T[K] extends RefValue<infer V>
? Ref<V>
: T[K] extends ComputedRefValue<infer V>
? ComputedRef<V>
: T[K] extends WritableComputedRefValue<infer V>
? WritableComputedRef<V>
: T[K] extends RefValue<infer V>
? Ref<V>
: T[K] extends object
? T[K] extends
| Function