toRef

类别

响应性

导出大小

180 B

最后更改

9 分钟前

别名

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>

类型声明

/**
 * Normalize value/ref/getter to `ref` or `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 于 2025/3/10

5e046 - 特性!: 移除 CJS 构建，现在仅支持 ESM (#4581)

v12.8.0 于 2025/3/5

7432f - 特性(类型): 弃用 MaybeRef 和 MaybeRefOrGetter，支持 Vue 原生类型 (#4636)

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

0a9ed - 特性!: 移除 Vue 2 支持，优化 bundles 并清理代码 (#4349)

v10.0.0 于 2023/4/14

cb6f9 - 修复: 改进类型重载，关闭 #2925

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

4d757 - 特性(类型)!: 重命名 MaybeComputedRef 为 MaybeRefOrGetter

f307f - 特性: 支持来自 Vue 的双参数重写

10e98 - 特性!: 重命名 resolveRef 为 toRef