getInvalidTypeMessage() — vue Function Reference

Architecture documentation for the getInvalidTypeMessage() function in props.ts from the vue codebase.

Function typescript CoreRuntime InstanceState calls 4 called by 1

Entity Profile

CoreRuntime→ InstanceState→ getInvalidTypeMessage() — vue Function Reference

Dependency Diagram

graph TD
  f8ecec2a_1fad_8b20_e61a_042f9e543aa9["getInvalidTypeMessage()"]
  dcde110b_8854_c944_bfb4_3d5581f6359e["assertProp()"]
  dcde110b_8854_c944_bfb4_3d5581f6359e -->|calls| f8ecec2a_1fad_8b20_e61a_042f9e543aa9
  c57c7f31_12a9_617f_4d2b_f5f5170fa30c["toRawType()"]
  f8ecec2a_1fad_8b20_e61a_042f9e543aa9 -->|calls| c57c7f31_12a9_617f_4d2b_f5f5170fa30c
  6e637bc6_945e_9083_7e42_8a4d14822f6f["isExplicable()"]
  f8ecec2a_1fad_8b20_e61a_042f9e543aa9 -->|calls| 6e637bc6_945e_9083_7e42_8a4d14822f6f
  e219dbb3_5881_eb4b_8817_0fb4b1a01ff7["isBoolean()"]
  f8ecec2a_1fad_8b20_e61a_042f9e543aa9 -->|calls| e219dbb3_5881_eb4b_8817_0fb4b1a01ff7
  684eb34b_3e95_185f_4266_b6d10b60cedd["styleValue()"]
  f8ecec2a_1fad_8b20_e61a_042f9e543aa9 -->|calls| 684eb34b_3e95_185f_4266_b6d10b60cedd
  style f8ecec2a_1fad_8b20_e61a_042f9e543aa9 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

src/core/util/props.ts lines 214–235

function getInvalidTypeMessage(name, value, expectedTypes) {
  let message =
    `Invalid prop: type check failed for prop "${name}".` +
    ` Expected ${expectedTypes.map(capitalize).join(', ')}`
  const expectedType = expectedTypes[0]
  const receivedType = toRawType(value)
  // check if we need to specify expected value
  if (
    expectedTypes.length === 1 &&
    isExplicable(expectedType) &&
    isExplicable(typeof value) &&
    !isBoolean(expectedType, receivedType)
  ) {
    message += ` with value ${styleValue(value, expectedType)}`
  }
  message += `, got ${receivedType} `
  // check if we need to specify received value
  if (isExplicable(receivedType)) {
    message += `with value ${styleValue(value, receivedType)}.`
  }
  return message
}