基于其他成员类型的条件成员类型

时间:2017-04-24 10:34:33

标签: typescript

是否可以根据具体条件指定多种可能的成员类型?例如,提供以下类型:

interface DataItem {
    value: boolean | Date | string | string[];
    options: undefined | string[];
}

我想指定if:

  • value的类型为booleanDate,然后options 必须属于undefined类型。
  • value的类型为stringstring[],然后options 必须属于string[]类型。

今天有没有在当前版本的TypeScript(2.2)中指定上述约束?此外,如果有,那么我假设在一个成员上添加类型保护应该适用于其他成员,即:

let data: DataItem;
if (typeof data.value === 'boolean') {
    data.options = ['a']; // => Error Type 'string[]' is not assignable to type 'undefined'.
}

我尝试了以下但是没有用:

interface BooleanOrDateItem {
    value: boolean | Date;
}

interface StringOrStringArrayDataItem {
    value: string | string[];
    options: string[];
}

type DataItem = BooleanOrDateItem | StringOrStringArrayDataItem;

let data: DataItem;

if (typeof data.value === 'string') {
    // I would expect this to work but the compiler complains 
    // => Property 'options' does not exist on type 'DataItem'.
    //          Property 'options' does not exist on type 'BooleanOrDateItem'.
    data.options = ['a'];
}

明确投射到StringOrStringArray显然有效

if (typeof data.value === 'string') {
    (<StringOrStringArrayDataItem>data).options = ['a'];
}

但是编译器不应该代表我这样做,因为它有足够的信息来推断data类型为StringOrStringArrayDataItem吗?

1 个答案:

答案 0 :(得分:2)

我相信你正在寻找User-defined Type Guards。在每个if语句之后,如果返回值为dataItem,TypeScript会将true的类型缩小为正确的类型。

interface DataItem {
    value: boolean | Date | string | string[];
    options: undefined | string[];
}

interface BoolOrDateDataItem extends DataItem {
    value: boolean | Date;
    options: undefined;
}
interface StringDataItem extends DataItem {
    value: string | string[];
    options: string[];
}

function isBoolOrDateDataItem(dataItem: DataItem): dataItem is BoolOrDateDataItem {
    return typeof dataItem.value === 'boolean' || dataItem.value instanceof Date;
}

function isStringDataItem(dataItem: DataItem): dataItem is StringDataItem {
    return typeof dataItem.value === 'string' || dataItem.value instanceof Array;
}

let dataItem: DataItem = {
    value: true,
    options: undefined
} // Or whatever it may be

if (isStringDataItem(dataItem)) {
    dataItem.value = new Date(); // TypeScript warns value must be string | string[] - knows it is a StringDataItem here
} else if (isBoolOrDateDataItem(dataItem)) {
    dataItem.value = true; // No error
}

它确实有点冗长,但似乎是推荐的做事方式。