createReadonly() — vue Function Reference

Architecture documentation for the createReadonly() function in readonly.ts from the vue codebase.

Function typescript CompilerSFC DescriptorParser calls 5 called by 2

Entity Profile

CompilerSFC→ DescriptorParser→ createReadonly() — vue Function Reference

Dependency Diagram

graph TD
  4f0f141e_f70c_4533_8c1b_de374c265d9a["createReadonly()"]
  b9b46a3f_0087_05b4_53ce_28ce6e544d03["readonly()"]
  b9b46a3f_0087_05b4_53ce_28ce6e544d03 -->|calls| 4f0f141e_f70c_4533_8c1b_de374c265d9a
  08354a11_4492_ce57_82ac_aaf1fc3adbc9["shallowReadonly()"]
  08354a11_4492_ce57_82ac_aaf1fc3adbc9 -->|calls| 4f0f141e_f70c_4533_8c1b_de374c265d9a
  e415240e_774b_2bed_aedc_a5e7fb23cfb9["isCollectionType()"]
  4f0f141e_f70c_4533_8c1b_de374c265d9a -->|calls| e415240e_774b_2bed_aedc_a5e7fb23cfb9
  3d048a11_6942_67b5_c66e_0aa58e3d5e37["isReadonly()"]
  4f0f141e_f70c_4533_8c1b_de374c265d9a -->|calls| 3d048a11_6942_67b5_c66e_0aa58e3d5e37
  1cb75796_39e2_4190_8602_3712ff6cf2f7["isRef()"]
  4f0f141e_f70c_4533_8c1b_de374c265d9a -->|calls| 1cb75796_39e2_4190_8602_3712ff6cf2f7
  a641b7eb_3a6c_54f5_9c98_7b09f54970d3["isShallow()"]
  4f0f141e_f70c_4533_8c1b_de374c265d9a -->|calls| a641b7eb_3a6c_54f5_9c98_7b09f54970d3
  66ae8013_0070_caaa_9e3a_a6b7cdb9bc85["defineReadonlyProperty()"]
  4f0f141e_f70c_4533_8c1b_de374c265d9a -->|calls| 66ae8013_0070_caaa_9e3a_a6b7cdb9bc85
  style 4f0f141e_f70c_4533_8c1b_de374c265d9a fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

src/v3/reactivity/readonly.ts lines 44–97

function createReadonly(target: any, shallow: boolean) {
  if (!isPlainObject(target)) {
    if (__DEV__) {
      if (isArray(target)) {
        warn(`Vue 2 does not support readonly arrays.`)
      } else if (isCollectionType(target)) {
        warn(
          `Vue 2 does not support readonly collection types such as Map or Set.`
        )
      } else {
        warn(`value cannot be made readonly: ${typeof target}`)
      }
    }
    return target as any
  }

  if (__DEV__ && !Object.isExtensible(target)) {
    warn(
      `Vue 2 does not support creating readonly proxy for non-extensible object.`
    )
  }

  // already a readonly object
  if (isReadonly(target)) {
    return target as any
  }

  // already has a readonly proxy
  const existingFlag = shallow ? rawToShallowReadonlyFlag : rawToReadonlyFlag
  const existingProxy = target[existingFlag]
  if (existingProxy) {
    return existingProxy
  }

  const proxy = Object.create(Object.getPrototypeOf(target))
  def(target, existingFlag, proxy)

  def(proxy, ReactiveFlags.IS_READONLY, true)
  def(proxy, ReactiveFlags.RAW, target)

  if (isRef(target)) {
    def(proxy, RefFlag, true)
  }
  if (shallow || isShallow(target)) {
    def(proxy, ReactiveFlags.IS_SHALLOW, true)
  }

  const keys = Object.keys(target)
  for (let i = 0; i < keys.length; i++) {
    defineReadonlyProperty(proxy, target, keys[i], shallow)
  }

  return proxy as any
}