type predicate 与 assertion function 组合为何无法收窄类型?
结论
type predicate 可以与 assertion function 配合使用。题目中的报错与 TypeScript 对 asserts b is true 和条件别名的控制流分析有关:编译器收窄了 isValid,却没有通过它的初始化表达式继续收窄 s。
在支持条件别名收窄的 TypeScript 版本中,可以将断言签名改为 asserts b。也可以直接使用 if (!test(s)) throw ...,或编写一个声明 asserts data is string 的函数,减少对间接推导的依赖。
这个问题可以理解为控制流分析的能力限制。题目没有提供 TypeScript 版本,无法确认它是否是某个版本的回归,或是否已被官方认定为 bug。
为什么 if 可以,原来的断言却不行?
test 的返回类型包含 type predicate:
(data: unknown): data is T;
当编译器分析 test(s) 成立的控制流时,可以将 s 收窄为 string。
题目将这个条件保存到了常量中:
const isValid = test(s);
在支持条件别名分析的编译器中,判断 isValid 的真假时,编译器可以继续利用 test(s) 的类型信息。例如:
function f(s: unknown): string {
const isValid = test(s);
if (!isValid) {
throw new Error();
}
return s;
}
原来的断言签名是:
declare function assertIsTrue(b: boolean): asserts b is true;
这个签名断言参数的类型为 true。在题目所示的行为中,编译器会将实参 isValid 收窄为 true,但不会根据这一收窄结果继续分析初始化条件 test(s),所以 s 仍然是 unknown。
两种写法在运行时可以表达相同的检查,但 TypeScript 的收窄路径不同。
方案一:将签名改为 asserts b
asserts b 表示函数正常返回时,传入的条件为真。编译器可以按条件成立的路径分析参数表达式。
保留原来的函数名,修改断言签名并提供相应实现:
interface ValidateFunction<T = unknown> {
(data: unknown): data is T;
}
declare const test: ValidateFunction<string>;
function assertIsTrue(b: boolean): asserts b {
if (!b) {
throw new Error();
}
}
function f(s: unknown): string {
const isValid = test(s);
assertIsTrue(isValid);
return s;
}
参数仍限定为 boolean,因此运行时只有 true 能通过检查。修改后的签名表示条件成立,编译器可以利用 const isValid 的条件别名关系继续收窄 s。
这种间接写法依赖编译器对条件别名的支持。如果项目使用的版本仍无法完成推导,可以使用下面的直接分支。
方案二:直接对校验调用分支判断
如果不需要通用断言工具,可以直接写出失败路径:
function f(s: unknown): string {
if (!test(s)) {
throw new Error();
}
return s;
}
失败分支会抛出异常。执行到 return s 时,test(s) 已经成立,type predicate 可以直接作用于 s。
原问题中的 if (!valid) throw new Error(); 使用了不同的变量名;如果保留结果变量,应写成 if (!isValid) throw new Error();。
需要复用时,直接断言待校验参数
如果业务代码经常需要在校验后继续使用数据,可以将校验包装成一个直接断言参数类型的函数:
function assertValidString(data: unknown): asserts data is string {
if (!test(data)) {
throw new Error();
}
}
function f(s: unknown): string {
assertValidString(s);
return s;
}
调用处可以直接获得 s is string 的保证,无需通过布尔变量间接推导。
注意事项
declare function 只提供类型声明,不会生成运行时代码。原示例适合说明类型问题,实际运行时仍需提供 test 和断言函数的实现。
TypeScript 会信任 assertion function 声明的保证,运行时实现必须在校验失败时抛出异常。这里的 test 也应符合示例中同步返回布尔值的 ValidateFunction<string> 契约。
不建议仅用 return s as string 消除报错,因为它不会建立校验结果与类型之间的关系,也不会增加运行时检查。
备注:内容仅供参考。
