具有相同参数的 TypeScript 多个 return 类型

Question

背景

为了融入 TypeScript 的精神，我在我的组件和服务中编写了完全类型化的签名，它扩展到我的 angular2 表单的自定义验证函数。

我知道 I can overload a function signature，但这需要每个 return 类型的参数不同，因为 tsc 将每个签名编译为一个单独的函数：

function pickCard(x: {suit: string; card: number; }[]): number;
function pickCard(x: number): {suit: string; card: number; };
function pickCard(x): any { /*common logic*/ };

我也知道我可以 return 单一类型（如 Promise），它可以本身是多个子类型：

private active(): Promise<void|null> { ... }

但是，在 angular2 自定义表单验证器的上下文中，单个签名（一个 FormControl 类型的参数）可以 return 两种不同的类型：Object 有表单错误，或 null 表示控件没有错误。

这显然行不通：

private lowercaseValidator(c: FormControl): null;
private lowercaseValidator(c: FormControl): Object {
    return /[a-z]/g.test(c.value) ? null : { lowercase: this.validationMessages.lowercase };
}

也不

private lowercaseValidator(c: FormControl): null|Object {...}
private lowercaseValidator(c: FormControl): <null|Object> {...}

（有趣的是，我收到以下错误，而不是更多信息：

error TS1110: Type expected.
error TS1005: ':' expected.
error TS1005: ',' expected.
error TS1128: Declaration or statement expected.

)

TL;DR

我只是简单地使用

private lowercaseValidator(c: FormControl): any { ... }

这似乎否定了类型签名的优势？

更一般，期待ES6

虽然这个问题的灵感来自 angular2 表单验证器，它由框架直接处理，所以你可能不关心声明 return 类型，但它仍然普遍适用，特别是考虑到 ES6 构造，如function (a, b, ...others) {}

也许避免编写可以 return 多种类型的函数是更好的做法，但由于 JavaScript 的动态特性，它是相当惯用的。

参考资料

TypeScript function overloading
Typescript syntax for a function returning observable or multiple type
https://github.com/Microsoft/TypeScript/issues/11700
https://github.com/Microsoft/TypeScript/issues/10727 (...spread) {}
https://github.com/Microsoft/TypeScript/issues/10571 < , , type>

Answer 1

好的，如果你想要正确的类型，这是正确的方法：

type CustomType = { lowercase: TypeOfTheProperty };
// Sorry I cannot deduce type of this.validationMessages.lowercase,
// I would have to see the whole class. I guess it's something
// like Array<string> or string, but I'm not Angular guy, just guessing.

private lowercaseValidator(c: FormControl): CustomType | null {
    return /[a-z]/g.test(c.value) ? null : { lowercase: this.validationMessages.lowercase };
}

更一般的例子

type CustomType = { lowercase: Array<string> };

class A {
      private obj: Array<string>;

      constructor() {
            this.obj = Array<string>();
            this.obj.push("apple");
            this.obj.push("bread");
      }

      public testMethod(b: boolean): CustomType | null {
            return b ? null : { lowercase: this.obj };
      }
}

let a = new A();
let customObj: CustomType | null = a.testMethod(false);
// If you're using strictNullChecks, you must write both CustomType and null
// If you're not CustomType is sufficiant

Answer 2

添加到 Erik 的回复中。在他的第二个示例的最后一行中，您可以使用“as”关键字而不是重新声明类型。

let customObj = a.testMethod(false) as CustomType;

所以基本上，如果您有一个具有多个 return 类型的函数，您可以使用“as”关键字指定应将哪些类型分配给变量。

type Person = { name: string; age: number | string };

const employees: Person[] = [
  { name: "John", age: 42},
  { name: "April", age: "N/A" }
];

const canTakeAlcohol = employees.filter(emp => {
  (emp.age as number) > 21;
});

具有相同参数的 TypeScript 多个 return 类型

TypeScript multiple return types with identical parameters

typescript

angular2-forms

typescript2.0

背景

TL;DR

更一般，期待ES6

参考资料

更一般的例子