Typescript 重载类型 boolean 不能分配给 false 类型

Question

我有一个根据选项键值返回不同类型的方法。

class Test {
  getData(options: { obj: true }): Object;
  getData(options: { obj: false }): any[];
  getData(): any[];
  getData(options = { obj: false }): Object | any[] {
    if (options.obj) {
      return {};
    } else {
      return [];
    }
  }
}

当将obj 作为true 传递时，我将返回对象，否则返回数组。效果很好。

const instance = new Test();
const result = instance.getData({ obj: true }); // inffered as array
const result2 = instance.getData(); // inffered as object

问题是当我需要使用动态值时它会抛出一个错误：

boolean 类型不能分配给 false 类型

function getResult(obj: boolean = false ) {
  return instance.getData({ obj });
}

有什么问题？

Answer 1

由于{ obj } 的类型在编译时仅称为{ obj: boolean }，编译器无法知道选择任何重载，因此您必须显式提供采用{ obj: boolean } 的重载（因为实现签名不算作函数的公共签名），在这种情况下编译器不会做任何魔术：

class Test {
    getData(options: { obj: true }): Object;
    getData(options: { obj: false }): any[];
    getData(options: { obj: boolean }): Object | any[];
    getData(): any[];
    // This signature is the implementation and is not conidered when resolving the method 
    getData(options = { obj: false }): Object | any[] {
        if (options.obj) {
            return {};
        } else {
            return [];
        }
    }
} 

编辑

您还可以在方法签名中使用条件类型，这样可以减少签名的数量：

class Test {
    getData<T extends boolean>(options: { obj: T }): T extends true ? Object : any[];
    getData(): any[];
    // This signature is the implementation and is not conidered when resolving the method 
    getData(options = { obj: false }): Object | any[] {
        if (options.obj) {
            return {};
        } else {
            return [];
        }
    }
}


const instance = new Test();
const result = instance.getData({ obj: true }); // inffered as array
const result2 = instance.getData(); // inffered as object

function getResult(obj: boolean = false) {
    return instance.getData({ obj }); // inferred as Object|any[]
}

由于type boolean = true | false 和条件类型分布在联合上， 当T 为boolean 时，T extends true ? Object : any[]; 将为Object|any[]。当T 为true 时，返回为Object，当T 为false 时，返回为any 都符合预期

Answer 2

例如，您不能像在 C# 中那样重载 TypeScript 中的方法。您需要组合类型，如下所示：

class Test {

  getData(options: {obj: boolean} = { obj: false }): Object | any[]  {
   if (options.obj) {
        return {};
      } else {
        return [];
      }
   }
}

当你多次重新声明同名函数时，你只会得到最后一个作为最终定义，在运行时。