Skip to content

반응형 API: 유틸리티

isRef()

값이 ref 객체인지 확인합니다.

  • 타입:

    function isRef<T>(r: Ref<T> | unknown): r is Ref<T>
    

    반환 타입은 type predicate이므로, isRef를 타입 가드로 사용할 수 있습니다.

    let foo: unknown
    if (isRef(foo)) {
      // foo의 타입은 Ref<unknown>으로 한정됨
      foo.value
    }
    

unref()

인자가 ref이면 내부 값을 반환하고, 그렇지 않으면 인자 자체를 반환합니다. 이것은 val = isRef(val) ? val.value : val과 같습니다.

  • 타입:

    function unref<T>(ref: T | Ref<T>): T
    
  • 예제:

    function useFoo(x: number | Ref<number>) {
      const unwrapped = unref(x)
      // unwrapped는 이제 확실히 숫자 입니다
    }
    

toRef()

반응형 객체의 속성에 대한 ref를 만드는 데 사용할 수 있습니다. 생성된 ref는 소스 속성과 동기화됩니다. 소스 속성을 변경하면 ref가 업데이트되고 그 반대의 경우도 마찬가지입니다.

  • 타입:

    function toRef<T extends object, K extends keyof T>(
      object: T,
      key: K,
      defaultValue?: T[K]
    ): ToRef<T[K]>
    
    type ToRef<T> = T extends Ref ? T : Ref<T>
    
  • 예제:

    const state = reactive({
      foo: 1,
      bar: 2
    })
    
    const fooRef = toRef(state, 'foo')
    
    // ref를 변경하면 원본도 업데이트 됨
    fooRef.value++
    console.log(state.foo) // 2
    
    // 원본을 변경하면 ref도 업데이트 됨
    state.foo++
    console.log(fooRef.value) // 3
    

    이것은 다음과 다름에 주의해야 합니다:

    const fooRef = ref(state.foo)
    

    위의 ref는 state.foo동기화되지 않습니다. ref()가 일반 숫자 값을 수신하기 때문입니다.

    toRef()는 컴포저블 함수에 prop을 ref로 전달하려는 경우에 유용합니다:

    <script setup>
    import { toRef } from 'vue'
    
    const props = defineProps(/* ... */)
    
    // `props.foo`를 ref로 변환한 다음 컴포저블 함수에 전달
    useSomeFeature(toRef(props, 'foo'))
    </script>
    

    toRef가 컴포넌트 props와 함께 사용되면, props 변경에 대한 일반적인 제한 사항이 계속 적용됩니다. ref에 새 값을 할당하려는 시도는 prop을 직접 수정하려는 것과 동일하며 허용되지 않습니다. 이런 경우에는 computed()getset을 선언하여 사용하는 것으로 구현할 수 있습니다. 자세한 내용은 컴포넌트를 v-model과 함께 사용하기 가이드 참고.

    toRef()는 소스 속성이 현재 존재하지 않더라도 사용 가능한 ref를 반환합니다. 이렇게 하면 toRefs에서 선택하지 않는 선택적 속성으로 작업할 수 있습니다.

toRefs()

반응형 객체를 일반 객체로 변환하고, 변환된 일반 객체의 각 속성은 원본 객체(반응형 객체)의 속성이 ref된 것 입니다. 각 개별 ref는 toRef()를 사용하여 생성됩니다.

  • 타입:

    function toRefs<T extends object>(
      object: T
    ): {
      [K in keyof T]: ToRef<T[K]>
    }
    
    type ToRef = T extends Ref ? T : Ref<T>
    
  • 예제:

    const state = reactive({
      foo: 1,
      bar: 2
    })
    
    const stateAsRefs = toRefs(state)
    /*
    stateAsRefs의 타입: {
      foo: Ref<number>,
      bar: Ref<number>
    }
    */
    
    // 원본 속성이 ref와 "연결됨"
    state.foo++
    console.log(stateAsRefs.foo.value) // 2
    
    stateAsRefs.foo.value++
    console.log(state.foo) // 3
    

    toRefs는 컴포저블 함수에서 반응형 객체를 반환하면, 이것을 사용하는 컴포넌트가 반응형을 잃지 않고 분해 할당 및 확장 할 수 있어 유용합니다.

    function useFeatureX() {
      const state = reactive({
        foo: 1,
        bar: 2
      })
    
      // ...state를 사용하여 작동하는 로직
    
      // 반환할 때 refs로 변환
      return toRefs(state)
    }
    
    // 반응형을 잃지 않고 분해 할당 가능
    const { foo, bar } = useFeatureX()
    

    toRefs는 호출 시 소스 객체에서 열거 가능한 속성만 참조로 생성합니다. 아직 존재하지 않을 수 있는 속성에 대한 참조를 생성하려면 toRef를 사용해야 합니다.

isProxy()

객체가 reactive(), readonly(), shallowReactive() 또는 shallowReadonly()에 의해 생성된 프락시인지 확인합니다.

  • 타입:

    function isProxy(value: unknown): boolean
    

isReactive()

객체가 reactive() 또는 shallowReactive()에 의해 생성된 프락시인지 확인합니다.

  • 타입:

    function isReactive(value: unknown): boolean
    

isReadonly()

객체가 readonly() 또는 shallowReadonly()에 의해 생성된 프락시인지 확인합니다.

  • 타입:

    function isReadonly(value: unknown): boolean
    
반응형 API: 유틸리티 has loaded