SuperAPI AI 工具集

convex-schema-validators

编程与开发

查看项目

更新于 10-16 02:39

技能介绍

用途:该技能用于指导 Convex 的 schema 设计、校验器(validators)与 TypeScript 类型集成,帮助在 Convex 项目中实现类型安全开发。

主要能力:

  1. Schema 定义:使用 defineSchema、defineTable 定义表结构,支持链式 .index() 与 .searchIndex() 建立索引与全文搜索索引。
  2. 校验器参考:涵盖基础校验器(v.string、v.number、v.boolean、v.null、v.int64、v.bytes)与复杂校验器(v.id、v.array、v.object、v.record、v.union、v.optional、v.literal、v.any),并给出可空、可选、枚举式联合、嵌套对象等常见模式。
  3. 函数校验:query、mutation、action 均需显式 returns 校验器;示例包含参数与返回值定义,以及从 schema 提取校验器并 extend 系统字段(_id、_creationTime)的用法。
  4. TypeScript 类型:从 ./_generated/dataModel 导入 Doc、Id,从 ./_generated/server 导入 QueryCtx、MutationCtx、ActionCtx 及函数构造器;强调禁止使用 any(@typescript-eslint/no-explicit-any 会导致构建失败)。
  5. 索引设计:命名约定 by_field1_and_field2,复合索引可通过前缀匹配服务多种查询,避免冗余索引。

使用方式:在创建或修改 convex/schema.ts、定义函数参数与返回值校验器、处理文档 ID 与类型、设置索引、处理可选字段与联合类型、集成 Convex 类型与 TypeScript 时使用。

适用场景:Convex 后端开发中的数据库建模、类型安全约束与查询优化。

限制与注意:资料未提供安装命令、收费信息或平台支持范围;内容以代码示例与规则说明为主,需结合 Convex 官方环境使用。