如何在Typescript中定义通用Type Guard?

时间:2019-11-23 16:09:56

标签: angular typescript

我想为我的类定义一个接口,该接口包含一个用作类型防护的isValidConfig函数。但是我不确定如何声明它。

我已经做到了:

type AnyConfig = ConfigA | ConfigB | ConfigC;

public abstract isValidConfig<T extends AnyConfig>(config: AnyConfig): config is T;

  public abstract isValidConfig<T = AnyConfig>(config: T): config is T;

但是我总是在实现中遇到错误,例如:

public isValidConfig<T extends ConfigA >(config: T): config is T {
    return config.type === TrainingTypes.A;
} /// Types of parameters 'config' and 'config' are incompatible.
      Type 'T' is not assignable to type 'ConfigA '.

是否可以这样做?我还没找到路。

1 个答案:

答案 0 :(得分:0)

该错误是因为您没有针对通用强制执行的防护措施。以下来自官方TS文档:https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards

您可以执行以下操作来防止使用单个类型:


enum ConfigTypes {
  a = 'a',
  b = 'b',
  c = 'c'
}

interface ConfigA {
  field: number;
  type: ConfigTypes.a;
}

interface ConfigB {
  otherField: string;
  type: ConfigTypes.b;
}

interface ConfigC {
  yetAnotherField: string[];
  type: ConfigTypes.c;
}

type AnyConfig = ConfigA | ConfigB | ConfigC;

export function isValidConfigA(config: AnyConfig): config is ConfigA {
  return config.type === ConfigTypes.a;
}


值得补充的是,类型必须在编译时强制执行,因为TypeScript根本无法执行运行时检查(到那时,它已经被转换为JavaScript,后者可以执行动态(运行时)检查)。换句话说,您只能防范特定的已知类型。

如果要检查给定的预期配置是否为配置,然后从上面的示例继续进行,可以执行以下操作:

export function isValidConfig(config: AnyConfig): config is AnyConfig {
  return (
    config.type === ConfigTypes.a ||
    config.type === ConfigTypes.b ||
    config.type === ConfigTypes.c
  );
}