toRef

Category

響應性

導出大小

180 B

Last Changed

9 minutes ago

Alias

resolveRef

Related

toValue

Normalize value/ref/getter to ref or computed.

Usage

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>

Type Declarations

/**
 * 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

Source

原始碼 • 文件

Contributors

Anthony Fu

IlyaL

Anthony Fu

Changelog

v13.0.0 on 2025/3/10

5e046 - feat!: 移除 CJS 建構，現在僅支援 ESM (#4581)

v12.8.0 on 2025/3/5

7432f - feat(types): 棄用 MaybeRef 和 MaybeRefOrGetter，改用 Vue 原生型別 (#4636)

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

0a9ed - feat!: 移除 Vue 2 支援，最佳化 bundles 並清理程式碼 (#4349)

v10.0.0 on 2023/4/14

cb6f9 - fix: 改善型別覆載，關閉 #2925

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

4d757 - feat(types)!: 將 MaybeComputedRef 重新命名為 MaybeRefOrGetter

f307f - feat: 支援來自 Vue 的雙參數覆蓋

10e98 - feat!: 將 resolveRef 重新命名為 toRef