跳到主要内容

createRef

分类
导出大小
113 B
上次更改
3 个月前

根据 deep 参数返回一个 deepRefshallowRef

用法

ts
import { 
createRef
} from '@vueuse/core'
import {
isShallow
,
ref
} from 'vue'
const
initialData
= 1
const
shallowData
=
createRef
(
initialData
)
const
deepData
=
createRef
(
initialData
, true)
isShallow
(
shallowData
) // true
isShallow
(
deepData
) // false
js
import { createRef } from '@vueuse/core'
import { isShallow } from 'vue'
const initialData = 1
const shallowData = createRef(initialData)
const deepData = createRef(initialData, true)
isShallow(shallowData) // true
isShallow(deepData) // false

类型声明

ts
export type 
CreateRefReturn
<
T
= any,
D
extends boolean = false,
> =
ShallowOrDeepRef
<
T
,
D
>
export type
ShallowOrDeepRef
<
T
= any,
D
extends boolean = false,
> =
D
extends true ?
Ref
<
T
> :
ShallowRef
<
T
>
/** * Returns a `deepRef` or `shallowRef` depending on the `deep` param. * * @example createRef(1) // ShallowRef<number> * @example createRef(1, false) // ShallowRef<number> * @example createRef(1, true) // Ref<number> * @example createRef("string") // ShallowRef<string> * @example createRef<"A"|"B">("A", true) // Ref<"A"|"B"> * * @param value * @param deep * @returns the `deepRef` or `shallowRef` * * @__NO_SIDE_EFFECTS__ */ export declare function
createRef
<
T
= any,
D
extends boolean = false>(
value
:
T
,
deep
?:
D
,
):
CreateRefReturn
<
T
,
D
>

来源

源码文档

贡献者

Robin
SerKo

更新日志

v13.6.0
d32f8 - refactor: 为所有纯函数添加 @__NO_SIDE_EFFECTS__ 注释 (#4907)
v13.1.0
c1d6e - feat(shared): 确保返回类型存在 (#4659)
v12.8.0
9afee - feat(useCached): 添加 options.deepRefs (#4591)

根据 MIT 许可证发布。