refactor: preserve refs in reactive arrays
BREAKING CHANGE: reactive arrays no longer unwraps contained refs
When reactive arrays contain refs, especially a mix of refs and
plain values, Array prototype methods will fail to function
properly - e.g. sort() or reverse() will overwrite the ref's value
instead of moving it (see #737).
Ensuring correct behavior for all possible Array methods while
retaining the ref unwrapping behavior is exceedinly complicated; In
addition, even if Vue handles the built-in methods internally, it
would still break when the user attempts to use a 3rd party utility
functioon (e.g. lodash) on a reactive array containing refs.
After this commit, similar to other collection types like Map and
Set, Arrays will no longer automatically unwrap contained refs.
The usage of mixed refs and plain values in Arrays should be rare in
practice. In cases where this is necessary, the user can create a
computed property that performs the unwrapping.
This commit is contained in:
@@ -29,7 +29,6 @@ export function isRef(r: any): r is Ref {
|
||||
}
|
||||
|
||||
export function ref<T>(value: T): T extends Ref ? T : Ref<T>
|
||||
export function ref<T>(value: T): Ref<T>
|
||||
export function ref<T = any>(): Ref<T>
|
||||
export function ref(value?: unknown) {
|
||||
if (isRef(value)) {
|
||||
@@ -83,8 +82,6 @@ function toProxyRef<T extends object, K extends keyof T>(
|
||||
} as any
|
||||
}
|
||||
|
||||
type UnwrapArray<T> = { [P in keyof T]: UnwrapRef<T[P]> }
|
||||
|
||||
// corner case when use narrows type
|
||||
// Ex. type RelativePath = string & { __brand: unknown }
|
||||
// RelativePath extends object -> true
|
||||
@@ -94,7 +91,7 @@ type BaseTypes = string | number | boolean
|
||||
export type UnwrapRef<T> = {
|
||||
cRef: T extends ComputedRef<infer V> ? UnwrapRef<V> : T
|
||||
ref: T extends Ref<infer V> ? UnwrapRef<V> : T
|
||||
array: T extends Array<infer V> ? Array<UnwrapRef<V>> & UnwrapArray<T> : T
|
||||
array: T
|
||||
object: { [K in keyof T]: UnwrapRef<T[K]> }
|
||||
}[T extends ComputedRef<any>
|
||||
? 'cRef'
|
||||
|
||||
Reference in New Issue
Block a user