TypeScript接口Never类型使用报错：字段匹配问题咨询

问题描述 #

我编写了一段TypeScript代码，在使用Never类型定义字段时遇到IDE报错：

• 当isAnonymous设为false时，本以为可以省略primaryIdentityHash和primaryIdentitySpace字段，但IDE提示缺少这两个字段；
• 当isAnonymous设为true时，返回的{ isAnonymous: true }无法赋值给StrictContract类型，提示缺少primaryIdentityHash、primaryIdentitySpace字段。

相关代码 #

export const getOneDSCoreFieldsUnAuth = (
  context: TelemetryLoggerContext,
): CoreFields => {
  return {
    app: {
      name: context.appName,
      platform: '',
      version: '1',
    },
    session: {
      id: context.correlationId,
    },
    user: {
      isAnonymous: true,
    },
  };
};

export declare namespace User {
  interface Contract {
    primaryIdentityHash?: string;
    primaryIdentitySpace?: string;
    tenantId?: string;
    tenantGroup?: string;
    isAnonymous?: boolean;
  }
  type StrictContractKnownUser = {
    primaryIdentityHash: string;
    primaryIdentitySpace: PrimaryIdentitySpace;
    tenantId?: string;
    tenantGroup?: string;
    isAnonymous?: false;
  };
  type StrictContractUnknownUser = {
    primaryIdentityHash: never;
    primaryIdentitySpace: never;
    tenantId?: never;
    tenantGroup?: never;
    isAnonymous: true;
  };
  type StrictContract = StrictContractKnownUser | StrictContractUnknownUser;
}

报错信息 #

Type '{ isAnonymous: true; }' is not assignable to type 'StrictContract'.
Type '{ isAnonymous: true; }' is missing the following properties from type 'StrictContractUnknownUser': primaryIdentityHash, primaryIdentitySpacets(2322)
DataModels.d.ts(193, 5): The expected type comes from property 'user' which is declared here on type 'CoreFields'

问题根源 #

1. StrictContractUnknownUser中定义的primaryIdentityHash: never和primaryIdentitySpace: never存在逻辑矛盾：never类型没有合法取值，但字段被设为必填，导致无法生成符合该类型的对象；
2. StrictContractKnownUser的isAnonymous?: false是可选字段，TypeScript无法通过该字段明确区分联合类型的分支，因此会要求对象满足所有分支的必填字段。

解决方案 #

采用可辨识联合类型，通过isAnonymous作为明确的区分标识，同时调整never类型字段的定义：

修改后的User命名空间代码 #

export declare namespace User {
  interface Contract {
    primaryIdentityHash?: string;
    primaryIdentitySpace?: string;
    tenantId?: string;
    tenantGroup?: string;
    isAnonymous?: boolean;
  }
  // 已知用户：明确标记isAnonymous为false，必填身份字段
  type StrictContractKnownUser = {
    primaryIdentityHash: string;
    primaryIdentitySpace: PrimaryIdentitySpace;
    tenantId?: string;
    tenantGroup?: string;
    isAnonymous: false; // 改为必填的辨识字段
  };
  // 匿名用户：明确标记isAnonymous为true，移除不需要的never字段
  type StrictContractUnknownUser = {
    tenantId?: never;
    tenantGroup?: never;
    isAnonymous: true;
    // 若需兼容原有接口，可改为可选never类型：
    // primaryIdentityHash?: never;
    // primaryIdentitySpace?: never;
  };
  type StrictContract = StrictContractKnownUser | StrictContractUnknownUser;
}

修改说明 #

• 将StrictContractKnownUser的isAnonymous?: false改为isAnonymous: false，让它成为必填的辨识字段，TypeScript可通过该字段精准区分联合类型分支；
• 移除StrictContractUnknownUser中无法赋值的必填never字段，匿名用户无需这些属性；若需兼容原有接口，可将这些字段改为可选never类型，既符合类型约束又不需要赋值；
• 修改后，{ isAnonymous: true }可正常赋值给StrictContract，isAnonymous: false时则必须传入primaryIdentityHash和primaryIdentitySpace字段，符合业务逻辑。

内容的提问来源于stack exchange，提问作者Khoi Tran