TypeScript类型守卫无法检测非空类对象属性问题求助

你定义的amplitudeFeatureFlags是AmplitudeFeatureFlags | {}的联合类型，虽然用了flagName in this.amplitudeFeatureFlags做检查，但TypeScript的类型守卫没法自动把{}类型排除——因为TypeScript里的{}类型表示不包含任何已知属性的对象，但它允许存在任意未知属性，所以in操作符无法让TypeScript确定当前对象就是AmplitudeFeatureFlags类型，导致索引时报错。

下面是几种可行的修复方式：

方案1：改用Partial<AmplitudeFeatureFlags>替代联合类型 #

直接把属性类型换成Partial<AmplitudeFeatureFlags>，它表示AmplitudeFeatureFlags的所有属性都是可选的，空对象{}完全符合这个类型，而且索引枚举值时不会有类型问题：

class User {
  // 替换成Partial类型
  private amplitudeFeatureFlags: Partial<AmplitudeFeatureFlags> = {};

  getAmplitudeFeatureFlagPayload(flagName: AmplitudeFeatureFlagNames) {
    return this.amplitudeFeatureFlags[flagName]?.payload;
    // 甚至可以去掉if判断，因为Partial类型允许属性不存在，?.操作符会自动处理
  }
}

方案2：使用类型断言收窄类型 #

如果一定要保留原联合类型，可以在if判断后把对象断言成AmplitudeFeatureFlags：

class User {
  private amplitudeFeatureFlags: AmplitudeFeatureFlags | {} = {};

  getAmplitudeFeatureFlagPayload(flagName: AmplitudeFeatureFlagNames) {
    if (flagName in this.amplitudeFeatureFlags) {
      // 断言为AmplitudeFeatureFlags类型
      return (this.amplitudeFeatureFlags as AmplitudeFeatureFlags)[flagName]?.payload;
    }
    // 补充默认返回值，避免函数无返回路径的类型警告
    return undefined;
  }
}

方案3：自定义类型守卫函数 #

写一个专门的类型守卫函数，明确判断对象是否为AmplitudeFeatureFlags类型：

function isAmplitudeFeatureFlags(
  obj: unknown
): obj is AmplitudeFeatureFlags {
  if (typeof obj !== 'object' || obj === null) return false;
  const flagNames = Object.values(AmplitudeFeatureFlagNames);
  return flagNames.every(name => name in obj);
}

class User {
  private amplitudeFeatureFlags: AmplitudeFeatureFlags | {} = {};

  getAmplitudeFeatureFlagPayload(flagName: AmplitudeFeatureFlagNames) {
    if (isAmplitudeFeatureFlags(this.amplitudeFeatureFlags)) {
      return this.amplitudeFeatureFlags[flagName]?.payload;
    }
    return undefined;
  }
}

推荐用方案1，因为Partial<AmplitudeFeatureFlags>最贴合你的使用场景——既允许初始为空对象，又能正确支持枚举索引的类型检查，代码也最简洁。

内容的提问来源于stack exchange，提问作者Gleb Gaiduk