用于处理数据库架构默认值的 Typescript 实用程序类型

Question

我正在寻找一种方法来为数据库模式键入默认值和虚拟值（也就是从其他值自动生成）值。 这个想法是使用实​​用程序类型来自动转换模式以进行插入（不需要具有默认值或由虚拟生成的道具），另一方面作为查询结果（例如，我们确定这些字段将由默认值或其他NonNullable “虚拟”的设置，以便将它们标记为NonNullable ）。

因此，如果我们将类型简化为单个 prop：

type WithDefault<T> = T;
// Mark prop as optional
type Input<T> = T extends WithDefault<infer T> ? T | undefined : T;

一个明显的问题是 Input<WithDefault> 和 Input 之间没有区别。 有什么想法可以帮助实现这样的模式吗？ 以如下模式结束：

type User = {
  firstName: string
  lastName: string
  fullName: WithDefault<string>
}

并且能够在可插入模式和可读模式之间来回切换。

Answer 1

问题 - 正如你所说 - 是类型在结构上是等效的，所以 TS 对待它们是一样的。

你可以用一些带有 type never 的属性来标记它，以区分两者。 缺点是您添加了一个不需要存在的属性，但是您可以通过使用 Symbol 来缓解这种情况，因为它保证是唯一的。

下面的代码（TS 游乐场链接在这里）：

const __hasDefault = Symbol('__hasDefault');

type WithDefault<T> = T & { [__hasDefault]: never }

type User = {
  firstName: string
  lastName: string
  fullName: WithDefault<string>
}

type ConvertSchema<S extends object> = {
  [key in keyof S]: S[key] extends WithDefault<infer T> ? T | undefined : S[key];
}

type result = ConvertSchema<User>;

这为您提供了以下结果 - 这是您要找的吗？