SuperAPI AI 工具集

convex-functions

编程与开发

查看项目

更新于 10-15 22:39

技能介绍

用途:指导在 Convex 中编写查询(query)、变更(mutation)、动作(action)与 HTTP 动作(httpAction),并处理参数校验、错误处理、内部函数和运行时差异。

主要能力:区分四类函数的数据库访问、外部 API 调用与缓存特性;用 v 校验器定义 args 与 returns;用 ConvexError 抛出面向用户的错误;用 internalQuery/internalMutation/internalAction 保护敏感逻辑;用 ctx.scheduler.runAfter 调度延迟任务;用 httpRouter 注册 webhook 与 API 端点。

使用方式:查询用 ctx.db 只读读取并支持索引与响应式缓存;变更以事务方式读写数据库;动作通过 ctx.runQuery/ctx.runMutation 间接访问数据库并调用外部 API,使用 Node.js API 时需在文件顶部加 "use node";;HTTP 动作处理请求并返回 Response。示例遵循对象语法加 handler 属性、所有函数带参数校验器、数据库操作显式指定表名。

适用场景:数据读取、数据写入、外部集成、webhook 与自定义 API 端点。

限制与注意:不要在查询或变更中调用外部 API;不要用动作直接做数据库操作;始终定义 returns 校验器;除非明确指示,不要运行 npx convex deploy 或任何 git 命令。实现前应查阅 https://docs.convex.dev/functions 等官方文档,不要凭假设编写。