打字稿检查类型A ===类型B |输入C

时间:2019-03-07 14:30:42

标签: typescript types assert typeof keyof

在一个文件中,我有这样的东西:

export const _all = {
  a: '',
  b: '',
  c: '',
  d: '',
  e: '',
  f: '',
}
type AllKeysType = typeof _all;
export type AllKey = keyof AllKeysType;

在另一个文件中,我有这样的东西:

export const _keep = {
  a: '',
  b: '',
  d: '',
  e: '',
}
type KeepKeysType = typeof _keep;
export type KeepKey = keyof KeepKeysType;

export const _ignore = {
  c: '',
  f: '',
}
type IgnoreKeysType = typeof _ignore;
export type IgnoreKey = keyof IgnoreKeysType;

如何使用Typescript断言_all中定义的键始终等于_keep_ignore的并集。换句话说,AllKey应该始终等于KeepKey | |。 IgnoreKey

我希望Typescript编译器给我一个错误,如果开发人员通过添加新值(例如_all)来更新z却忘记将z添加到{{1 }}或_keep

1 个答案:

答案 0 :(得分:6)

这可以通过定义一个条件类型来实现,该条件类型接受两种类型,并在输入类型相等时解析为true,否则为false。然后编写一些代码,当该类型不是true时将引发编译错误。

当两种类型中的任何一种更改时,您都会收到编译错误,这将确保您记得更新任何不同步的类型。当您希望收到有关其他库中类型更改的通知时,此功能特别有用。

例如:

type IsExact<T, U> = [T] extends [U] ? [U] extends [T] ? true : false : false;
function assert<T extends true | false>(expectTrue: T) {}

// this will throw a compile error when the two types get out of sync
assert<IsExact<AllKey, KeepKey | IgnoreKey>>(true);

更健壮的代码要长一点(例如处理any类型),但是它已汇总到我的库here中。

import { assert, IsExact } from "conditional-type-checks";

// define or import AllKey, KeepKey, IgnoreKey

assert<IsExact<AllKey, KeepKey | IgnoreKey>>(true);

另一个选项

另一种不太好做的方法是创建两个类型的两个对象并将它们彼此分配。

() => {
  let allKeys: AllKey;
  let otherKeys: KeepKey | IgnoreKey;

  // do this in lambdas to prevent the first assignment from changing
  // the type of the variable being assigned to
  () => allKeys = otherKeys;
  () => otherKeys = allKeys;
};