getInvalidTypeMessage() — vue Function Reference

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

Function typescript CoreInstance Lifecycle calls 4 called by 1

Entity Profile

CoreInstance→ Lifecycle→ getInvalidTypeMessage() — vue Function Reference

Dependency Diagram

graph TD
  d3d22bbe_e895_cdde_5564_f0b46800e133["getInvalidTypeMessage()"]
  87f7db47_5b28_fa14_0778_0d908fd6f104["assertProp()"]
  87f7db47_5b28_fa14_0778_0d908fd6f104 -->|calls| d3d22bbe_e895_cdde_5564_f0b46800e133
  872a8457_76aa_9dfa_922f_0876e2f9171d["toRawType()"]
  d3d22bbe_e895_cdde_5564_f0b46800e133 -->|calls| 872a8457_76aa_9dfa_922f_0876e2f9171d
  5390e733_829f_f4f5_32ea_5e0459433996["isExplicable()"]
  d3d22bbe_e895_cdde_5564_f0b46800e133 -->|calls| 5390e733_829f_f4f5_32ea_5e0459433996
  fc21f526_c618_6227_d3ec_d358267e923e["isBoolean()"]
  d3d22bbe_e895_cdde_5564_f0b46800e133 -->|calls| fc21f526_c618_6227_d3ec_d358267e923e
  c8732bc1_7239_3c10_ebac_7796e11138c2["styleValue()"]
  d3d22bbe_e895_cdde_5564_f0b46800e133 -->|calls| c8732bc1_7239_3c10_ebac_7796e11138c2
  style d3d22bbe_e895_cdde_5564_f0b46800e133 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
}