跳到正文

我所理解的 TypeScript 最佳实践(19):用 never 表示没有值的类型

我所理解的 TypeScript 最佳实践

  1. 为什么选择 TypeScript
  2. 严格模式
  3. 使用常量枚举来管理状态
  4. 按运行环境处理 TypeScript 代码
  5. 类型检查、Lint 与测试
  6. TypeScript 7 升级与工具链兼容
  7. 用 satisfies 检查类型并保留推断
  8. 用 import type 区分类型依赖和运行时依赖
  9. 用对象类型表达字段约束
  10. 用联合类型表达备选,用交集类型叠加约束
  11. 用元组描述位置固定的数据
  12. 用泛型保留类型关系,用 extends 写约束和条件
  13. 按目标类型判断赋值是否成立
  14. 按输入和输出设计泛型的协变与逆变
  15. 先校验外部数据,再使用收窄后的类型
  16. 让局部实现保留推断,用注解约束公开接口
  17. 从一份定义派生配置、命令和事件的类型
  18. 用判别联合排除互斥的状态组合
  19. 用 never 表示没有值的类型(当前)
  20. 用逆向映射推断还原字段类型

联合类型的每个成员都代表一种可能的值。把所有成员排除后,TypeScript 用 never 表示没有值剩下。这个性质可以用来检查分支是否全覆盖、从联合类型里删除成员,也能解释为什么带泛型的 extends 遇到 never 时有时会得到一个意料之外的结果。

用 never 检查是否漏处理了分支

下面的保存结果有成功和失败两种状态。switch 处理了这两种状态,进入 default 时,检查器已经把两个成员都排除了,所以 result 的类型是 never。把它传给只接收 never 的函数,就可以让检查器验证分支是否齐全。这个写法依赖 TypeScript 的控制流收窄。

// 保存结果的两个分支各自携带需要展示的信息。
type SaveResult = { status: 'saved'; path: string } | { status: 'failed'; message: string };

// 让遗漏的分支在编译时暴露,也为运行时的异常输入保留错误。
function assertNever(value: never): never {
  throw new Error(`未处理的保存结果:${JSON.stringify(value)}`);
}

// 根据保存结果生成界面消息。
function describeSaveResult(result: SaveResult): string {
  switch (result.status) {
    case 'saved': {
      return `已保存到 ${result.path}`;
    }
    case 'failed': {
      return result.message;
    }
    default: {
      return assertNever(result); // result 是 never。
    }
  }
}

给 SaveResult 增加 { status: 'cancelled' } 后,default 中的 result 就变成取消状态。由于取消状态无法赋给 never,编译器会在 assertNever(result) 处指出遗漏。来自接口的原始数据应先做运行时校验,再交给 describeSaveResult()。

assertNever 总会抛错,所以它可以声明返回 never,也可以用在外层函数要求返回 string 的位置。能正常执行完且调用方无需使用结果的函数,返回类型可以写 void。

让不保留的联合成员变成 never

把联合类型传给 T extends U ? X : Y 这样的条件类型,检查器会对 T 的各个成员分别计算。让要删除的成员返回 never,其余成员保留自己的类型。TypeScript 内置的 Exclude 就按这条规则筛选成员。

// 从联合中删除 Deleted 能接收的成员。
type Drop<Union, Deleted> = Union extends Deleted ? never : Union;

type Visible = Drop<'draft' | 'published' | 'archived', 'archived'>; // 'draft' | 'published'
type Empty = Drop<'archived', 'archived'>; // never

第一行结果由 'draft' | 'published' | never 合并而来。加入一个没有值的类型不会增加任何成员,所以最后只剩两个状态。

分配条件遇到 never 时没有成员可供比较

直接写 never extends true 会做一次可赋值判断,而给 T extends true 传入 never 时,分配条件先看联合里有几个成员可供比较。这个区别也会影响用泛型约束写的类型断言。

// 对 T 的联合成员分别检查。
type IsTrue<T> = T extends true ? true : false;

// 要求 T 能赋给 true,返回原来的 T。
type ExpectTrue<T extends true> = T;

type Direct = never extends true ? true : false; // true
type Distributed = IsTrue<never>; // never
type Constraint = ExpectTrue<never>; // 通过,结果是 never。

Direct 只比较一次,由于 never 可以赋给 true,结果是真分支。Distributed 会按条件类型的分配规则遍历联合成员,传入 never 时没有任何成员可比较,结果仍是 never。

Constraint 检查的也是赋值关系。通过后,ExpectTrue<T> 把类型实参 T 原样返回,所以得到的是传进去的 never。

如果要检查一个类型本身是不是 never,可以把两边都包起来。检查器这时比较整个单元素元组。

// 比较整个类型是否能赋给 never。
type IsNever<T> = [T] extends [never] ? true : false;

type NoValues = IsNever<never>; // true
type HasValues = IsNever<true | false>; // false

读库里的 [T] extends [U] 时,同样可以先判断它是在检查整个类型,还是需要对联合成员逐个筛选。双侧元组让检查器保留哪些泛型条件,可以对照 Vue 泛型 props 系列第 7 篇。