SuperAPI AI 工具集

convex-component-authoring

通用与其它

查看项目

更新于 10-15 22:39

技能介绍

用途:指导开发者创建、组织并发布自包含、可复用的 Convex 组件,实现跨项目共享。

主要能力:组件可包含与主应用隔离的数据库表、查询/变更/动作函数、TypeScript 类型与校验器,以及可选的前端 hooks。文档给出组件目录结构、convex.config.ts 配置、schema 定义、函数编写、主入口导出,以及在消费方应用中通过 app.use 注册并调用组件函数的完整流程,还包含限流器示例与发布用 package.json、tsconfig.json 配置。

使用方式:实现前应先查阅最新文档,主要来源为 https://docs.convex.dev/components 与 https://docs.convex.dev/components/authoring,更广上下文见 https://docs.convex.dev/llms.txt。组件通过 defineComponent 定义,schema 用 defineSchema/defineTable,函数用 query/mutation 等;消费方在 convex/convex.config.ts 中用 defineApp 与 app.use 注册,可指定名称或注册多个实例。

适用场景:需要将可复用后端逻辑(如限流、配置存储等)打包为独立组件并在多个 Convex 项目间共享时。

限制与注意事项:组件表应保持自包含,不应引用主应用表;需导出清晰类型并记录公开 API;遵循语义化版本;发布前应隔离测试。文档明确要求:除非被明确指示,否则不要运行 npx convex deploy,也不要运行任何 git 命令。具体收费、价格与平台支持等信息暂未提供。