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

时间:2016-10-25 14:15:33

标签: typescript angular2-forms typescript2.0

背景

尝试进入TypeScript的精神,我在我的组件和服务中编写完全类型的签名,这扩展到我的angular2表单的自定义验证函数。

我知道I can overload a function signature,但这要求每个返回类型的参数不同,因为tsc会将每个签名编译为单独的函数:

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

我也知道我可以返回单个类型(如Promise),本身可以是多个子类型:

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

但是,在angular2自定义表单验证程序的上下文中,单个签名(类型为FormControl的一个参数)可以返回两种不同的类型:带有表单错误的Objectnull表示控件没有错误。

这显然不起作用:

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表单验证器,所以你可能不关心声明返回类型,但它仍然普遍适用,尤其是在给出function (a, b, ...others) {}等ES6结构的情况下/ p>

或许只是更好的做法是避免编写可以返回多种类型的函数,但由于JavaScript的动态特性,这是相当惯用的。

参考

2 个答案:

答案 0 :(得分:8)

好的,如果你想拥有合适的类型,这是正确的方法:

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

答案 1 :(得分:1)

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

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

因此,基本上,如果您的函数具有多个返回类型,则可以使用“ 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;
});