Typescript 类型转换对象因此特定的必需键在类型中不再是可选的?

2024-01-11

假设你有一个对象类型:

type Person = {
  name?: string;
  color?: string;
  address?: string;
}

但是,您想将该类型更改为以下类型,您知道名称和颜色将存在。

type Person = {
  name: string;
  color: string;
  address?: string;
}

因此,有这样的函数

const throwIfUndefined = (
  object: {[key: string]: any},
  requiredKeys: string[]
): ReturnTypeHere => {
  for (const key of requiredKeys) {
    if (!object[key]) throw new Error("missing required key");
  }

  return object;
};

输入函数参数以及返回类型的正确方法是什么(ReturnTypeHere)?如果写得正确,下面的代码将 1) 抛出错误 2) 控制台记录名称。它永远不会控制台日志未定义。

const person = {...}

const requiredKeys = ["name", "color"];
const verifiedPerson = throwIfUndefined(person, requiredKeys);
console.log(verifiedPerson.name)

如果你有一个对象类型T和它的键的联合K你想要的,你可以写RequireKeys<T, K>像这样:

type RequireKeys<T extends object, K extends keyof T> =
  Required<Pick<T, K>> & Omit<T, K>;

这里我们使用的是Required<T> https://www.typescriptlang.org/docs/handbook/utility-types.html#requiredtype, Pick<T, K> https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys, and Omit<T, K> https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys实用程序类型。这里可能存在边缘情况,例如T有一个字符串索引签名并且string出现在里面K,但初步估计它应该可以工作。

也有点难以理解什么RequiredKeys<Person, "name" | "color">来自 IDE 中的显示方式:

type VerifiedPerson = RequireKeys<Person, "name" | "color">;
// type VerifiedPerson = Required<Pick<Person, "name" | "color">> & 
//   Omit<Person, "name" | "color">

如果您希望编译器更明确一点,您可以执行以下操作expand https://stackoverflow.com/questions/57683303/how-can-i-see-the-full-expanded-contract-of-a-typescript-type将类型放入其属性中:

type RequireKeys<T extends object, K extends keyof T> =
  (Required<Pick<T, K>> & Omit<T, K>) extends
  infer O ? { [P in keyof O]: O[P] } : never;

这导致

/* type VerifiedPerson = {
    name: string;
    color: string;
    address?: string | undefined;
} */

这更容易看到。

--

然后你需要做throwIfUndefined() a 通用函数 https://www.typescriptlang.org/docs/handbook/2/generics.html这样编译器就可以跟踪之间的关系object and requiredKeys传入:

const throwIfUndefined = <T extends object, K extends keyof T>(
  object: T,
  requiredKeys: readonly K[]
) => {
  for (const key of requiredKeys) {
    if (!object[key]) throw new Error("missing required key");
  }
  return object as unknown as RequireKeys<T, K> // need to assert this
};

并测试:

const person: Person = {
  ...Math.random() < 0.8 ? { name: "Alice" } : {},
  ...Math.random() < 0.8 ? { color: "Color for a person is problematic" } : {}
};
const requiredKeys = ["name", "color"] as const;
const verifiedPerson = throwIfUndefined(person, 
  requiredKeys); // possible runtime error here
// const verifiedPerson: RequireKeys<Person, "name" | "color">

如果你想让编译器记住文字类型 https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#literal-types "name" and "color"是以下组织的成员requiredKeys那么你需要做类似的事情const断言 https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-4.html#const-assertions (i.e., as const)这样告诉它。否则requiredKeys只会是string[]你会得到奇怪/错误的结果(我们可以防止这些结果,但它可能超出了这里的范围)。

现在,编译器明白了name and color被定义,而address仍然是可选的:

console.log(verifiedPerson.name.toUpperCase() + ": " +
  verifiedPerson.color.toUpperCase()); // no compile error
// [LOG]: "ALICE: COLOR FOR A PERSON IS PROBLEMATIC"

verifiedPerson.address // (property) address?: string | undefined
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

Typescript 类型转换对象因此特定的必需键在类型中不再是可选的? 的相关文章

随机推荐