set() — vue Function Reference

Architecture documentation for the set() function in index.ts from the vue codebase.

Function typescript CoreInstance Lifecycle calls 3 called by 2

Entity Profile

CoreInstance→ Lifecycle→ set() — vue Function Reference

Dependency Diagram

graph TD
  1c6c2c60_cb0c_a3fc_17fe_30271386e3b6["set()"]
  e4810382_8c74_bddb_f04c_e8c3ddc8a0e7["mergeData()"]
  e4810382_8c74_bddb_f04c_e8c3ddc8a0e7 -->|calls| 1c6c2c60_cb0c_a3fc_17fe_30271386e3b6
  ed9e592d_d374_e542_fb6c_6a607c8ec505["customRef()"]
  ed9e592d_d374_e542_fb6c_6a607c8ec505 -->|calls| 1c6c2c60_cb0c_a3fc_17fe_30271386e3b6
  38718d0e_50b6_f32c_7ce6_c7fe083f1ba2["observe()"]
  1c6c2c60_cb0c_a3fc_17fe_30271386e3b6 -->|calls| 38718d0e_50b6_f32c_7ce6_c7fe083f1ba2
  345b25ad_bb77_07cb_ecf5_8b82f12ddccd["defineReactive()"]
  1c6c2c60_cb0c_a3fc_17fe_30271386e3b6 -->|calls| 345b25ad_bb77_07cb_ecf5_8b82f12ddccd
  066df273_90c0_35dd_cd79_8e43c3f6c8ba["notify()"]
  1c6c2c60_cb0c_a3fc_17fe_30271386e3b6 -->|calls| 066df273_90c0_35dd_cd79_8e43c3f6c8ba
  style 1c6c2c60_cb0c_a3fc_17fe_30271386e3b6 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

src/core/observer/index.ts lines 223–276

export function set(
  target: any[] | Record<string, any>,
  key: any,
  val: any
): any {
  if (__DEV__ && (isUndef(target) || isPrimitive(target))) {
    warn(
      `Cannot set reactive property on undefined, null, or primitive value: ${target}`
    )
  }
  if (isReadonly(target)) {
    __DEV__ && warn(`Set operation on key "${key}" failed: target is readonly.`)
    return
  }
  const ob = (target as any).__ob__
  if (isArray(target) && isValidArrayIndex(key)) {
    target.length = Math.max(target.length, key)
    target.splice(key, 1, val)
    // when mocking for SSR, array methods are not hijacked
    if (ob && !ob.shallow && ob.mock) {
      observe(val, false, true)
    }
    return val
  }
  if (key in target && !(key in Object.prototype)) {
    target[key] = val
    return val
  }
  if ((target as any)._isVue || (ob && ob.vmCount)) {
    __DEV__ &&
      warn(
        'Avoid adding reactive properties to a Vue instance or its root $data ' +
          'at runtime - declare it upfront in the data option.'
      )
    return val
  }
  if (!ob) {
    target[key] = val
    return val
  }
  defineReactive(ob.value, key, val, undefined, ob.shallow, ob.mock)
  if (__DEV__) {
    ob.dep.notify({
      type: TriggerOpTypes.ADD,
      target: target,
      key,
      newValue: val,
      oldValue: undefined
    })
  } else {
    ob.dep.notify()
  }
  return val
}