InstantDB 中创建通用工具函数时遇到的类型问题解析

背景介绍

InstantDB 是一个提供实时数据库功能的工具，它允许开发者通过 TypeScript 类型系统来定义和操作数据模型。在使用过程中，开发者经常会遇到需要创建通用工具函数来处理不同类型实体的情况。

问题描述

在尝试创建一个通用的 newEntity 函数时，开发者遇到了类型检查不严格的问题。具体表现为：

1. 函数应该能够根据传入的集合类型（如 "users"）自动推断出该类型实体应有的属性
2. 但实际上，当传入错误的属性名或属性类型时，TypeScript 并没有正确地报错

解决方案

InstantDB 团队在 0.17.3 版本中引入了新的工具类型 UpdateParams 来解决这个问题。以下是正确的实现方式：

// 首先定义应用模式
const _schema = i.schema({ 
  entities: { 
    users: i.entity({ email: i.string() }) 
  } 
});

// 创建类型别名以便复用
type AppSchema = typeof _schema;
const schema: AppSchema = _schema;

// 初始化数据库连接
const db = init({
  adminToken: "...",
  appId: "...",
  schema,
});

// 获取所有集合类型
type Collection = keyof typeof schema.entities;

// 使用 UpdateParams 工具类型
type EntityUpdate<T extends Collection> = UpdateParams<typeof schema, T>;

// 改进后的通用实体创建函数
export const newEntity = async <T extends Collection>(
  type: T,
  props: EntityUpdate<T>,
) => {
  const theId = id();
  await db.transact(db.tx[type][theId].update(props));
  return theId;
};

关键改进点

1. 使用 UpdateParams 工具类型：这个新引入的类型能够准确地反映实体更新时允许的参数
2. 严格的类型检查：现在当传入不存在的属性或类型不匹配的属性时，TypeScript 会正确地报错
3. 模式定义分离：将模式定义与类型定义分离，提高了代码的可维护性

实际效果验证

// 正确用法 - 通过类型检查
const user1 = await newEntity("users", { email: "[e-mail]" });

// 错误用法1 - 不存在的属性 - 现在会报错
const user2 = await newEntity("users", { blabla: "[e-mail]" });

// 错误用法2 - 类型不匹配 - 现在会报错
const user3 = await newEntity("users", { email: 123 });

扩展建议

对于需要处理关联关系的情况，InstantDB 还提供了 LinkParams 工具类型，可以用来类型安全地处理实体间的关联。开发者可以按照类似的模式创建处理关联关系的通用函数。

总结

通过使用 InstantDB 提供的工具类型，开发者可以创建类型安全的通用函数，大大提高代码的可靠性和开发体验。这种方法不仅适用于实体创建，也可以推广到其他数据库操作场景中。