Vue 3 中 withDefaults 与布尔类型转换的注意事项

在 Vue 3 项目开发中，我们经常会使用 TypeScript 的类型系统和 withDefaults 来为组件 props 提供默认值。然而，当 props 类型涉及布尔值时，开发者可能会遇到一些意料之外的类型转换行为。

问题现象

当开发者尝试为可能包含布尔值和字符串的联合类型 props 设置默认值时，例如：

const props = withDefaults(defineProps<{
  error?: false | string
}>(), {
  error: ''
})

期望的是当不传递 error prop 时，其值应为空字符串 ''。但实际上，props.error 的值会变成 true。

原因分析

这是由于 Vue 3 内部的布尔类型转换机制导致的。Vue 会对布尔类型的 props 进行特殊处理：

1. 当 prop 类型包含布尔类型时，Vue 会启用布尔转换逻辑
2. 任何非 undefined 的值都会被转换为布尔值
3. 空字符串 '' 会被转换为 true

这种机制主要是为了支持类似 <Comp disabled /> 这样的简洁写法，其中 disabled 会被自动转换为 true。

解决方案

要避免这种自动转换，可以调整类型定义的顺序：

const props = withDefaults(defineProps<{
  error?: string | false  // 将字符串类型放在前面
}>(), {
  error: ''
})

这样修改后，Vue 会优先将 prop 视为字符串类型处理，而不会触发布尔类型转换。

最佳实践

1. 当 prop 需要支持多种类型时，将非布尔类型放在联合类型的前面
2. 如果确实需要布尔类型行为，建议使用纯布尔类型
3. 在复杂类型场景下，考虑使用运行时类型检查或自定义验证函数

总结

Vue 3 的布尔类型转换机制虽然方便了常见用例，但在处理联合类型时可能会产生意外结果。理解这一机制有助于开发者编写更可靠的组件 props 定义。在开发过程中，建议仔细测试 props 的各种使用场景，确保类型行为符合预期。