SuperAPI AI 工具集

inngest-setup

编程与开发

查看项目

更新于 10-15 22:38

技能介绍

用途:在 TypeScript 项目中从零接入 Inngest,为构建重试安全的 Webhook 处理器、崩溃后可恢复的后台任务和定时任务提供持久执行能力。资料偏 TypeScript,Python 与 Go 需参考 Inngest 官方文档。

前置条件:Node.js 18+(WebSocket 支持推荐 22.4+)、TypeScript 项目、包管理器(npm/yarn/pnpm/bun)。

安装与客户端:npm install inngest(或 yarn/pnpm/bun 对应命令)。创建共享客户端文件,例如 src/inngest/client.ts,导出 new Inngest({ id: "my-app" })。id 为必填的应用标识,使用连字符 slug。可配置 eventKey、env、isDev、signingKey、signingKeyFallback、baseUrl、logger、middleware。v4 默认 Cloud 模式,本地开发需设置 INNGEST_DEV=1,否则 serve 端点会返回 500(“In cloud mode but no signing key”);生产需设置 INNGEST_SIGNING_KEY。切勿硬编码 isDev: true。可用 eventType() 配合 zod 定义类型化事件,作为触发器或发送事件时获得类型安全。

环境变量:生产需要 INNGEST_EVENT_KEY 与 INNGEST_SIGNING_KEY;本地设 INNGEST_DEV=1,可选 INNGEST_BASE_URL(默认 http://localhost:8288)。不要硬编码密钥。

连接模式:A) Serve 端点(HTTP),适合 Vercel、Lambda 等无服务器平台与既有 API,按框架从 inngest/next、inngest/express、inngest/fastify、inngest/cloudflare、inngest/lambda 引入 serve;端点路径建议用 /api/inngest 以启用自动发现。Express 需 express.json({ limit: "10mb" })。v4 中 signingKey 等选项移至客户端构造器。B) Connect(WebSocket),适合 Kubernetes、Docker 等长驻进程,使用 inngest/connect 的 connect(),需 Node.js 22.4+(或 Deno 1.4+、Bun 1.1+),生产需签名密钥与事件键,并设置 appVersion。v4 中工作线程隔离默认开启。

组织与本地开发:可用多个 Inngest 实例按服务划分 App;id 变更会创建新 App,部署间应保持一致。本地用 npx --ignore-scripts=false inngest-cli@latest dev 启动开发服务器,支持 -u 指定 URL、-p 指定端口、--no-discovery 关闭自动发现,可传多个 -u。可选用 inngest.json 配置。

限制与常见问题:端口冲突可换端口;自动发现失败需手动 -u;函数未显示需确认 INNGEST_DEV、可达性与重启;生产签名错误需检查签名密钥;WebSocket 问题需确认 Node 版本;Docker 中开发用 host.docker.internal。资料未提供收费、价格或效果信息。