NestJS函数返回联合类型无法访问各类型属性问题求助

问题场景 #

现有两个类 ErrorDto 和 Data，服务中的 getResult 函数返回 Promise<ErrorDto | Data>。在 deletePaymentFile 函数调用该方法后，仅能访问 res.status（两个类的共有属性），无法直接访问 ErrorDto 的 message 属性或 Data 的 rows、isdeleted 属性；但如果返回单一类型，则可正常访问对应属性。

示例代码：

class ErrorDto {
  status: number;
  message: string;
}

class Data {
  status: number;
  rows: any[];
  isdeleted: boolean;
}

// 服务方法
function getResult(): Promise<ErrorDto | Data> {
  // 业务实现
}

async function deletePaymentFile() {
  const res = await getResult();
  // 仅能访问 res.status，res.message / res.rows 会报错
}

问题原因 #

TypeScript 中，联合类型在未进行类型收窄时，只能访问所有联合成员的共有属性。status 是 ErrorDto 和 Data 的共有属性，因此可以直接访问；而 message、rows、isdeleted 是各自独有的属性，TypeScript 无法确定当前 res 的具体类型，因此禁止直接访问。

解决方案 #

1. 自定义类型守卫 #

通过类型守卫函数明确区分两种类型，让 TypeScript 推断出具体类型：

// 类型守卫：判断是否为 ErrorDto
function isErrorDto(obj: ErrorDto | Data): obj is ErrorDto {
  return 'message' in obj;
}

// 类型守卫：判断是否为 Data
function isData(obj: ErrorDto | Data): obj is Data {
  return 'rows' in obj && 'isdeleted' in obj;
}

async function deletePaymentFile() {
  const res = await getResult();
  if (isErrorDto(res)) {
    // 此处 res 被推断为 ErrorDto，可访问 message
    console.log(res.message);
  } else {
    // 此处 res 被推断为 Data，可访问 rows 和 isdeleted
    console.log(res.rows, res.isdeleted);
  }
}

2. 使用区分联合类型 #

给两个类添加一个唯一的区分字段（如 type），让 TypeScript 自动完成类型推断：

class ErrorDto {
  type: 'error'; // 区分标识
  status: number;
  message: string;
}

class Data {
  type: 'data'; // 区分标识
  status: number;
  rows: any[];
  isdeleted: boolean;
}

// 更新返回类型
function getResult(): Promise<ErrorDto | Data> {
  // 返回实例需包含正确的 type 字段
  return Promise.resolve({ type: 'error', status: 400, message: '操作失败' });
}

async function deletePaymentFile() {
  const res = await getResult();
  if (res.type === 'error') {
    // 自动推断为 ErrorDto
    console.log(res.message);
  } else {
    // 自动推断为 Data
    console.log(res.rows, res.isdeleted);
  }
}

3. 类型断言（不推荐） #

如果能明确当前返回值的具体类型，可使用类型断言强制指定，但这种方式跳过了 TypeScript 的类型检查，存在安全风险：

async function deletePaymentFile() {
  const res = await getResult();
  // 断言为 ErrorDto
  const errorRes = res as ErrorDto;
  console.log(errorRes.message);

  // 断言为 Data
  const dataRes = res as Data;
  console.log(dataRes.rows);
}

内容的提问来源于stack exchange，提问作者Nurlan Kazdayev