toRef

类别

Reactivity

导出体积

180 B

上次更改

4 minutes ago

别名

resolveRef

相关

toValue

将值、ref 或 getter 规范化为 ref 或 computed。

用法

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>

类型声明

/**
 * 将值、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>>
/**
 * @deprecated use `toRef` instead
 */
export declare const resolveRef: typeof toRef

源码

源码 • 文档

贡献者

Anthony Fu

一纸忘忧

IlyaL

Anthony Fu

更新日志

v13.0.0 on 3/10/2025

5e046 - feat!: drop CJS build, now it's ESM-only (#4581)

v12.8.0 on 3/5/2025

7432f - feat(types): deprecate MaybeRef and MaybeRefOrGetter in favor of Vue's native (#4636)

v12.0.0-beta.1 on 11/21/2024

0a9ed - feat!: drop Vue 2 support, optimize bundles and clean up (#4349)

v10.0.0 on 4/14/2023

cb6f9 - fix: improve types overload, close #2925

v10.0.0-beta.4 on 4/13/2023

4d757 - feat(types)!: rename MaybeComputedRef to MaybeRefOrGetter

f307f - feat: support two argument overrides from Vue

10e98 - feat!: rename resolveRef to toRef