|
|
@@ -108,9 +108,9 @@ export declare const ShallowReactiveMarker: unique symbol
|
|
|
export type ShallowReactive<T> = T & { [ShallowReactiveMarker]?: true }
|
|
|
|
|
|
/**
|
|
|
- * Shallow version of {@link reactive()}.
|
|
|
+ * Shallow version of {@link reactive}.
|
|
|
*
|
|
|
- * Unlike {@link reactive()}, there is no deep conversion: only root-level
|
|
|
+ * Unlike {@link reactive}, there is no deep conversion: only root-level
|
|
|
* properties are reactive for a shallow reactive object. Property values are
|
|
|
* stored and exposed as-is - this also means properties with ref values will
|
|
|
* not be automatically unwrapped.
|
|
|
@@ -178,7 +178,7 @@ export type DeepReadonly<T> = T extends Builtin
|
|
|
* the original.
|
|
|
*
|
|
|
* A readonly proxy is deep: any nested property accessed will be readonly as
|
|
|
- * well. It also has the same ref-unwrapping behavior as {@link reactive()},
|
|
|
+ * well. It also has the same ref-unwrapping behavior as {@link reactive},
|
|
|
* except the unwrapped values will also be made readonly.
|
|
|
*
|
|
|
* @example
|
|
|
@@ -215,9 +215,9 @@ export function readonly<T extends object>(
|
|
|
}
|
|
|
|
|
|
/**
|
|
|
- * Shallow version of {@link readonly()}.
|
|
|
+ * Shallow version of {@link readonly}.
|
|
|
*
|
|
|
- * Unlike {@link readonly()}, there is no deep conversion: only root-level
|
|
|
+ * Unlike {@link readonly}, there is no deep conversion: only root-level
|
|
|
* properties are made readonly. Property values are stored and exposed as-is -
|
|
|
* this also means properties with ref values will not be automatically
|
|
|
* unwrapped.
|
|
|
@@ -298,8 +298,8 @@ function createReactiveObject(
|
|
|
}
|
|
|
|
|
|
/**
|
|
|
- * Checks if an object is a proxy created by {@link reactive()} or
|
|
|
- * {@link shallowReactive()} (or {@link ref()} in some cases).
|
|
|
+ * Checks if an object is a proxy created by {@link reactive} or
|
|
|
+ * {@link shallowReactive} (or {@link ref} in some cases).
|
|
|
*
|
|
|
* @example
|
|
|
* ```js
|
|
|
@@ -327,7 +327,7 @@ export function isReactive(value: unknown): boolean {
|
|
|
* readonly object can change, but they can't be assigned directly via the
|
|
|
* passed object.
|
|
|
*
|
|
|
- * The proxies created by {@link readonly()} and {@link shallowReadonly()} are
|
|
|
+ * The proxies created by {@link readonly} and {@link shallowReadonly} are
|
|
|
* both considered readonly, as is a computed ref without a set function.
|
|
|
*
|
|
|
* @param value - The value to check.
|
|
|
@@ -343,7 +343,7 @@ export function isShallow(value: unknown): boolean {
|
|
|
|
|
|
/**
|
|
|
* Checks if an object is a proxy created by {@link reactive},
|
|
|
- * {@link readonly}, {@link shallowReactive} or {@link shallowReadonly()}.
|
|
|
+ * {@link readonly}, {@link shallowReactive} or {@link shallowReadonly}.
|
|
|
*
|
|
|
* @param value - The value to check.
|
|
|
* @see {@link https://vuejs.org/api/reactivity-utilities.html#isproxy}
|
|
|
@@ -356,8 +356,8 @@ export function isProxy(value: any): boolean {
|
|
|
* Returns the raw, original object of a Vue-created proxy.
|
|
|
*
|
|
|
* `toRaw()` can return the original object from proxies created by
|
|
|
- * {@link reactive()}, {@link readonly()}, {@link shallowReactive()} or
|
|
|
- * {@link shallowReadonly()}.
|
|
|
+ * {@link reactive}, {@link readonly}, {@link shallowReactive} or
|
|
|
+ * {@link shallowReadonly}.
|
|
|
*
|
|
|
* This is an escape hatch that can be used to temporarily read without
|
|
|
* incurring proxy access / tracking overhead or write without triggering
|
|
|
@@ -397,7 +397,7 @@ export type Raw<T> = T & { [RawSymbol]?: true }
|
|
|
* ```
|
|
|
*
|
|
|
* **Warning:** `markRaw()` together with the shallow APIs such as
|
|
|
- * {@link shallowReactive()} allow you to selectively opt-out of the default
|
|
|
+ * {@link shallowReactive} allow you to selectively opt-out of the default
|
|
|
* deep reactive/readonly conversion and embed raw, non-proxied objects in your
|
|
|
* state graph.
|
|
|
*
|