TypeScript：如何为私有成员断言函数定义类型谓词以消除非空断言？

问题背景 #

在EmailParser类中，调用checkEvent方法后，TypeScript依然要求对私有成员currentGigData使用非空断言（!）。尝试使用类型谓词或asserts断言签名时，因currentGigData是私有成员，出现类型交集缩减为never的错误，改为公有成员可解决但破坏封装性。

可行方案：针对this的asserts断言签名 #

调整checkEvent方法的签名，使用asserts this is ...来断言当前实例的currentGigData非空，无需暴露私有成员即可让TypeScript正确推断类型。

修改后的代码如下：

private parseDate(text: string) {
  this.checkEvent("parseDate");

  const date = Number(text);
  if (!date) throw EmailParser.errors.couldntFindDate;

  const { month, year } = this.currentDateMarker;
  // 无需再使用非空断言!
  this.currentGigData.dateParts = {
    date, year, month
  };
}

private checkEvent(source: string): asserts this is this & { 
  currentGigData: NonNullable<typeof this.currentGigData> 
} {
  if (this.currentGigData === null) {
    throw EmailParser.errors.noEventStarted(source);
  }
}

原理说明 #

• asserts this is this & { ... }表示断言当前实例（this）同时满足原类型和指定的成员非空类型。
• 虽然currentGigData是私有成员，但在类内部的方法中，TypeScript允许通过这种方式断言实例的类型，因为类内部有权访问私有成员，不会触发类型交集为never的问题。
• 该方案既保持了类的封装性，又让TypeScript正确识别checkEvent执行后currentGigData的非空状态，消除了不必要的非空断言。

备选方案：在checkEvent中添加类型断言 #

如果上述asserts签名在某些TypeScript版本中存在兼容问题，也可以在checkEvent内部对this.currentGigData进行类型断言，不过这种方式需要手动维护：

private checkEvent(source: string) {
  if (this.currentGigData === null) {
    throw EmailParser.errors.noEventStarted(source);
  }
  // 手动断言当前成员非空
  this.currentGigData = this.currentGigData as NonNullable<typeof this.currentGigData>;
}

这种方式同样无需修改成员访问权限，TypeScript会在后续代码中识别currentGigData的非空状态。

内容的提问来源于stack exchange，提问作者Jonathan Tuzman