Skip to content

toRef

类别
导出体积
181 B
上次更改
1 hour ago
别名
resolveRef

将值、ref 或 getter 规范化为 refcomputed

用法

ts
import { 
toRef
} from '@vueuse/core'
const
foo
=
ref
('hi')
const
a
=
toRef
(0) // Ref<number>
const
b
=
toRef
(
foo
) // Ref<string>
const
c
=
toRef
(() => 'hi') // ComputedRef<string>

类型声明

ts
/**
 * 将值、ref 或 getter 规范化为 `ref` 或 `computed`。
 */
export declare function 
toRef
<
T
>(
r
: () =>
T
):
Readonly
<
Ref
<
T
>>
export declare function
toRef
<
T
>(
r
:
ComputedRef
<
T
>):
ComputedRef
<
T
>
export declare function
toRef
<
T
>(
r
:
MaybeRefOrGetter
<
T
>):
Ref
<
T
>
export declare function
toRef
<
T
>(
r
:
T
):
Ref
<
T
>
export declare function
toRef
<
T
extends object,
K
extends keyof
T
>(
object
:
T
,
key
:
K
,
):
ToRef
<
T
[
K
]>
export declare function
toRef
<
T
extends object,
K
extends keyof
T
>(
object
:
T
,
key
:
K
,
defaultValue
:
T
[
K
],
):
ToRef
<
Exclude
<
T
[
K
], undefined>>

源码

源码文档

贡献者

Anthony Fu
一纸忘忧
Vida Xie
IlyaL
Anthony Fu

更新日志

Pending for release...
971b2 - feat(shared)!: drop some deprecated apis (#5010)
5e046 - feat!: drop CJS build, now it's ESM-only (#4581)
7432f - feat(types): deprecate MaybeRef and MaybeRefOrGetter in favor of Vue's native (#4636)
0a9ed - feat!: drop Vue 2 support, optimize bundles and clean up (#4349)