# 为您的类型编写测试 ## 概述正如为运行时代码编写测试一样，您应该为您的类型编写测试。类型级代码也可能存在错误，并且类型声明可能与实现不同步。测试类型可确保您的声明正确工作并捕获应有的错误。类型测试对于库作者、复杂类型实用程序以及每当类型与实现分开定义时尤其重要。 ## 何时使用此技能 * 为库编写类型声明 * 创建复杂类型实用程序 * 类型和实现位于单独的文件中 * 重构类型级代码 * 类型包含条件逻辑或递归 ## 铁律 **为您的类型编写测试。测试有效类型是否有效、无效类型是否失败以及错误消息是否有帮助。** ## 检测注意这些情况： // 红旗 - 未经测试的类型逻辑 type ComplexTransform = /* 10 行条件类型 */; // 没有测试 - 你怎么知道它有效？声明函数libraryFn(输入：T): SomeTransform; // JS 中的实现，d.ts 中的类型 - 可能会偏离 ## 测试什么测试三件事： 1. **有效类型有效** \- 生成预期类型 2. **无效类型失败** \- 类型错误发生在预期的位置 3. **错误消息帮助** \- 错误引导用户修复 ## 使用 @ts-expect-error 进行测试使用“@ts-expect-error”断言一行应该产生类型错误： // myFunction.test.ts 从 './myFunction' 导入 { myFunction }； // 测试 1：有效类型有效 const result1 = myFunction('你好'); 类型 Test1 = 结果 1 的类型； // 应该是字符串 // 测试 2：无效类型失败 // @ts-expect-error - 数字无法分配给字符串 const result2 = myFunction(42); // 测试 3：错误消息有帮助 // 当错误消失时，TypeScript 会发出警告： //“未使用的‘@ts-expect-error’指令” ## 测试类型实用程序 // 类型-utils.ts 导出类型 DeepReadonly = { readonly [K in keyof T]: T[K] 扩展对象？深度只读 : T[K]; }; // 类型-utils.test.ts 从 './type-utils' 导入类型 { DeepReadonly }； // 测试：简单对象类型 Case1 = DeepReadonly<{ x: number }>; const test1: Case1 = { x: 1 }; // @ts-expect-error - 只读测试1.x = 2； // 测试：嵌套对象类型 Case2 = DeepReadonly<{ 嵌套: { 值: 字符串 } }>; const test2: Case2 = { 嵌套: { value: 'hi' } }; // @ts-expect-error - 深度只读 // @ts-expect-error - 深度只读 test2.nested.value = '再见'; // 测试：数组类型 Case3 = DeepReadonly; const test3: Case3 = ['a', 'b']; // @ts-expect-error - 只读数组 test3.push('c'); ## 使用期望类型进行测试 `expect-type` 库提供类型断言助手：从'expect-type'导入{expectType，expectError}； // 测试返回类型 const 结果 = myFunction('输入'); ExpectType<字符串>（结果）； // 测试是否发生错误期望错误（myFunction（42））； // 测试复杂类型接口用户{名称：字符串； } 常量用户 = fetchUser(); 期望类型<用户>(用户); ## 使用 tsd 进行测试 `tsd` 是一个用于测试类型定义的 CLI 工具： //index.test-d.ts 从“tsd”导入{expectType，expectError}；从 '.' 导入 { concat }； // 测试：字符串 + 字符串 = 字符串 ExpectType<字符串>(concat('foo', 'bar')); // 测试：数字 + 数字 = 数字 ExpectType<数字>(concat(1, 2)); // 测试：混合类型 = 错误 ExpectError(concat('foo', 1)); 运行：`npx tsd` ## 使用 Vitest 进行测试 Vitest 具有内置类型测试： // 测试/types.test-d.ts 从'vitest'导入{描述，expectTypeOf，it}；从'./utils'导入{pick}；描述('挑选', () => { it('应该选择指定的键', () => { const obj = { a: 1, b: 2, c: 3 }; const pick = pick(obj, 'a', 'b'); ExpectTypeOf(picked).toEqualTypeOf<{ a: 数字; b: 数字 }>(); }); it('不应允许未选取的键', () => { const obj = { a: 1, b: 2 }; const pick = pick(obj, 'a'); // @ts-expect-error - 'b' 未被选中挑选.b; }); }); 运行：`npx vitest typecheck` ## 测试错误消息好的错误消息是 API 的一部分： // 测试错误消息是否有帮助类型 Check = T 扩展字符串 ? T：从不； // 不好：错误只是“类型‘number’不能分配给类型‘never’” 类型错误 = 检查<编号>; // 更好：使用有意义的类型名称类型 CheckWithMessage = T 扩展字符串？时间 : '错误：需要字符串，收到其他内容'; ## 测试边缘情况 // 使用联合进行测试类型 UnionTest = MyType<字符串 |数量>; // 应该分发：MyType |我的类型<数字> // 使用 never 进行测试类型 NeverTest = MyType; // 永远不应该优雅地处理 // 测试任意类型 AnyTest = MyType; // 不应崩溃或产生意外结果 // 使用复杂对象进行测试类型 ComplexTest = MyType<{ a: { b: { c: string } } }>; // 应该正确处理嵌套 ## 抗压协议当被迫跳过型式测试时： 1. **显示风险**：未经测试的类型可能存在细微的错误 2. **从简单开始**：`@ts-expect-error` 测试很容易添加 3. **自动化**：将类型测试添加到 CI 管道 4. **文档**：测试作为复杂类型的文档 ## 危险信号反模式|为什么它很糟糕 ---|--- 复杂实用程序无需进行类型测试 |错误不会被注意到仅测试快乐路径 |边缘情况破裂从测试中输入单独的文件 |可能会渐行渐远 IDE 中的手动测试 |不可重现 ## 常见的合理化 ###“类型检查器会捕获错误” **现实**：类型检查器会验证您的类型，但不会验证您的类型是否正确。只有测试才能做到这一点。 ### “这只是类型，而不是真正的代码” **现实**：类型是在编译时运行的代码。复杂类型逻辑需要像运行时逻辑一样进行测试。 ###“如果有东西坏了我会注意到的” **现实**：类型错误很微妙。在用户报告问题之前，您可能不会注意到。 ## 快速参考工具|最适合 |命令 ---|---|--- @ts-预期错误 |快速测试，在线|内置期望类型 |单元测试风格 | `npm 测试` TSD |库定义 | `npx tsd` 维泰斯特 |完整的测试套件| `npx vitest 类型检查` dtslint |绝对打字 | `npx dtslint` ## 底线类型是代码，需要测试。使用“@ts-expect-error”进行快速检查，使用专用库进行全面测试。测试有效案例、无效案例和错误消息。 ## 参考 * 有效的 TypeScript，第二版，作者：Dan Vanderkam * 第 55 项：为您的类型编写测试

测试你的类型

包含技能