如何消除TypeScript对doAnotherThing方法中this.property.uid的未定义报错？

问题场景 #

以下TypeScript代码中，execSomething方法会先获取并验证Property实例，赋值给this.property后调用doAnotherThing。doAnotherThing中已经通过checkProperty方法校验this.property（不存在则抛出错误），但TypeScript仍提示TS2532: Object is possibly 'undefined'错误，希望避免到处添加?.、!或重复的if判断：

export default class Alerts {
  private alertsList: AlertEntry[] = []
  private property?: Property
  
  public execSomething(){
    const prop = someMagicHere() // fetch and validate property
    if(!prop){
      return false
    }
    this.property = prop
    this.doAnotherThing()
    
  }
  
  private checkProperty(): void {
    if (!this.property) {
      throw new Error('Imóvel não definido')
    }
  }
  
  private async doAnotherThing(): any {
    this.checkProperty() // 已校验但TS仍报错

    this.property.uid // TS2532: Object is possibly 'undefined'.    
    return {}
  }
}

解决方案：使用断言函数（Assertion Functions） #

TypeScript默认的控制流分析是局部性的，无法自动跟踪跨方法的状态校验，但可以通过断言函数显式告知TS：执行完某个函数后，特定条件一定成立。

修改checkProperty方法为断言函数，指定执行后this的类型会被缩小为包含非可选property的类型：

private checkProperty(): asserts this is { property: Property } {
  if (!this.property) {
    throw new Error('Imóvel não definido')
  }
}

这样，当doAnotherThing中调用this.checkProperty()后，TypeScript会自动识别this.property已经被确保为非undefined，不再抛出TS2532错误。

原理说明 #

断言函数通过asserts关键字定义，它告诉TypeScript的类型检查器：只要函数正常执行（不抛出错误），那么断言的条件必然成立。这种方式可以将跨方法的校验逻辑转化为TypeScript可识别的类型信息，无需额外的类型断言或重复判断。

内容的提问来源于stack exchange，提问作者Neuber Oliveira