feat(types): expose ToRefs type (#1037)

vuejs · Apr 24, 2020 · 28b4c31 · 28b4c31
1 parent c9f10be
commit 28b4c31
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 5 deletions.
diff --git a/packages/reactivity/src/index.ts b/packages/reactivity/src/index.ts
@@ -8,7 +8,8 @@ export {
  customRef,
  triggerRef,
  Ref,
- UnwrapRef
+ UnwrapRef,
+ ToRefs
 } from './ref'
 export {
  reactive,

diff --git a/packages/reactivity/src/ref.ts b/packages/reactivity/src/ref.ts
@@ -20,6 +20,8 @@ export interface Ref<T = any> {
  value: T
 }
 
+export type ToRefs<T = any> = { [K in keyof T]: Ref<T[K]> }
+
 const convert = <T extends unknown>(val: T): T =>
  isObject(val) ? reactive(val) : val
 
@@ -108,9 +110,7 @@ export function customRef<T>(factory: CustomRefFactory<T>): Ref<T> {
  return r as any
 }
 
-export function toRefs<T extends object>(
- object: T
-): { [K in keyof T]: Ref<T[K]> } {
+export function toRefs<T extends object>(object: T): ToRefs<T> {
  if (__DEV__ && !isProxy(object)) {
  console.warn(`toRefs() expects a reactive object but received a plain one.`)
  }

diff --git a/packages/runtime-core/src/index.ts b/packages/runtime-core/src/index.ts
@@ -153,7 +153,8 @@ export {
  Ref,
  ComputedRef,
  UnwrapRef,
- WritableComputedOptions
+ WritableComputedOptions,
+ ToRefs
 } from '@vue/reactivity'
 export {
  // types