import { track, trigger } from './effect' import { TrackOpTypes, TriggerOpTypes } from './operations' import { isArray, isObject, hasChanged } from '@vue/shared' import { reactive, isProxy, toRaw, isReactive } from './reactive' import { CollectionTypes } from './collectionHandlers' declare const RefSymbol: unique symbol export interface Ref { value: T /** * Type differentiator only. * We need this to be in public d.ts but don't want it to show up in IDE * autocomplete, so we use a private Symbol instead. */ [RefSymbol]: true /** * @internal */ _shallow?: boolean } export type ToRef = [T] extends [Ref] ? T : Ref> export type ToRefs = { // #2687: somehow using ToRef here turns the resulting type into // a union of multiple Ref<*> types instead of a single Ref<* | *> type. [K in keyof T]: T[K] extends Ref ? T[K] : Ref> } const convert = (val: T): T => isObject(val) ? reactive(val) : val export function isRef(r: Ref | unknown): r is Ref export function isRef(r: any): r is Ref { return Boolean(r && r.__v_isRef === true) } export function ref(value: T): ToRef export function ref(value: T): Ref> export function ref(): Ref export function ref(value?: unknown) { return createRef(value) } export function shallowRef( value: T ): T extends Ref ? T : Ref export function shallowRef(value: T): Ref export function shallowRef(): Ref export function shallowRef(value?: unknown) { return createRef(value, true) } class RefImpl { private _value: T public readonly __v_isRef = true constructor(private _rawValue: T, public readonly _shallow = false) { this._value = _shallow ? _rawValue : convert(_rawValue) } get value() { track(toRaw(this), TrackOpTypes.GET, 'value') return this._value } set value(newVal) { if (hasChanged(toRaw(newVal), this._rawValue)) { this._rawValue = newVal this._value = this._shallow ? newVal : convert(newVal) trigger(toRaw(this), TriggerOpTypes.SET, 'value', newVal) } } } function createRef(rawValue: unknown, shallow = false) { if (isRef(rawValue)) { return rawValue } return new RefImpl(rawValue, shallow) } export function triggerRef(ref: Ref) { trigger(toRaw(ref), TriggerOpTypes.SET, 'value', __DEV__ ? ref.value : void 0) } export function unref(ref: T): T extends Ref ? V : T { return isRef(ref) ? (ref.value as any) : ref } const shallowUnwrapHandlers: ProxyHandler = { get: (target, key, receiver) => unref(Reflect.get(target, key, receiver)), set: (target, key, value, receiver) => { const oldValue = target[key] if (isRef(oldValue) && !isRef(value)) { oldValue.value = value return true } else { return Reflect.set(target, key, value, receiver) } } } export function proxyRefs( objectWithRefs: T ): ShallowUnwrapRef { return isReactive(objectWithRefs) ? objectWithRefs : new Proxy(objectWithRefs, shallowUnwrapHandlers) } export type CustomRefFactory = ( track: () => void, trigger: () => void ) => { get: () => T set: (value: T) => void } class CustomRefImpl { private readonly _get: ReturnType>['get'] private readonly _set: ReturnType>['set'] public readonly __v_isRef = true constructor(factory: CustomRefFactory) { const { get, set } = factory( () => track(this, TrackOpTypes.GET, 'value'), () => trigger(this, TriggerOpTypes.SET, 'value') ) this._get = get this._set = set } get value() { return this._get() } set value(newVal) { this._set(newVal) } } export function customRef(factory: CustomRefFactory): Ref { return new CustomRefImpl(factory) as any } export function toRefs(object: T): ToRefs { if (__DEV__ && !isProxy(object)) { console.warn(`toRefs() expects a reactive object but received a plain one.`) } const ret: any = isArray(object) ? new Array(object.length) : {} for (const key in object) { ret[key] = toRef(object, key) } return ret } class ObjectRefImpl { public readonly __v_isRef = true constructor(private readonly _object: T, private readonly _key: K) {} get value() { return this._object[this._key] } set value(newVal) { this._object[this._key] = newVal } } export function toRef( object: T, key: K ): ToRef { return isRef(object[key]) ? object[key] : (new ObjectRefImpl(object, key) as any) } // corner case when use narrows type // Ex. type RelativePath = string & { __brand: unknown } // RelativePath extends object -> true type BaseTypes = string | number | boolean /** * This is a special exported interface for other packages to declare * additional types that should bail out for ref unwrapping. For example * \@vue/runtime-dom can declare it like so in its d.ts: * * ``` ts * declare module '@vue/reactivity' { * export interface RefUnwrapBailTypes { * runtimeDOMBailTypes: Node | Window * } * } * ``` * * Note that api-extractor somehow refuses to include `declare module` * augmentations in its generated d.ts, so we have to manually append them * to the final generated d.ts in our build process. */ export interface RefUnwrapBailTypes {} export type ShallowUnwrapRef = { [K in keyof T]: T[K] extends Ref ? V : T[K] } export type UnwrapRef = T extends Ref ? UnwrapRefSimple : UnwrapRefSimple type UnwrapRefSimple = T extends | Function | CollectionTypes | BaseTypes | Ref | RefUnwrapBailTypes[keyof RefUnwrapBailTypes] ? T : T extends Array ? { [K in keyof T]: UnwrapRefSimple } : T extends object ? UnwrappedObject : T // Extract all known symbols from an object // when unwrapping Object the symbols are not `in keyof`, this should cover all the // known symbols type SymbolExtract = (T extends { [Symbol.asyncIterator]: infer V } ? { [Symbol.asyncIterator]: V } : {}) & (T extends { [Symbol.hasInstance]: infer V } ? { [Symbol.hasInstance]: V } : {}) & (T extends { [Symbol.isConcatSpreadable]: infer V } ? { [Symbol.isConcatSpreadable]: V } : {}) & (T extends { [Symbol.iterator]: infer V } ? { [Symbol.iterator]: V } : {}) & (T extends { [Symbol.match]: infer V } ? { [Symbol.match]: V } : {}) & (T extends { [Symbol.matchAll]: infer V } ? { [Symbol.matchAll]: V } : {}) & (T extends { [Symbol.replace]: infer V } ? { [Symbol.replace]: V } : {}) & (T extends { [Symbol.search]: infer V } ? { [Symbol.search]: V } : {}) & (T extends { [Symbol.species]: infer V } ? { [Symbol.species]: V } : {}) & (T extends { [Symbol.split]: infer V } ? { [Symbol.split]: V } : {}) & (T extends { [Symbol.toPrimitive]: infer V } ? { [Symbol.toPrimitive]: V } : {}) & (T extends { [Symbol.toStringTag]: infer V } ? { [Symbol.toStringTag]: V } : {}) & (T extends { [Symbol.unscopables]: infer V } ? { [Symbol.unscopables]: V } : {}) type UnwrappedObject = { [P in keyof T]: UnwrapRef } & SymbolExtract