upstash-workflow-js

Upstash Workflow SDK

捆绑的文档和源码

在编写或调试 SDK 代码之前，请先检查 node_modules/@upstash/workflow/docs/ 中的捆绑文档，以及 node_modules/@upstash/workflow/src/ 中可读的 TypeScript 源码。相关文件存在时，请阅读并搜索；否则，请使用本技能中的参考资料。

快速入门

Upstash Workflow SDK 可让你公开无服务器工作流端点，并在底层使用 QStash 可靠地运行这些工作流。

安装：

npm install @upstash/workflow

定义一个简单的工作流端点：

import { serve } from "@upstash/workflow";

export const { POST } = serve(async (context) => {
  await context.run("step-1", () => console.log("step 1"));
  await context.run("step-2", () => console.log("step 2"));
});

从你的后端触发它：

import { Client } from "@upstash/workflow";

const client = new Client({ token: process.env.QSTASH_TOKEN! });
await client.trigger({ url: "https://your-app.com/api/workflow" });

其他技能文件

这些文件包含完整文档，可供查阅详情、模式和高级行为。

• 基础：
  • basics/serve – 如何公开工作流端点。
  • basics/context – 工作流 context 的完整 API（步骤、等待、Webhook、事件、调用等）。
  • basics/client – 使用 Workflow 客户端触发、取消、查看和通知运行。
• 功能：
  • features/invoke – 跨工作流调用。
  • features/reliability – 重试、失败回调和 DLQ。
  • features/flow-control – 速率限制、并发和并行处理。
  • features/wait-for-event – 通知和等待事件模式。
  • features/webhooks – 创建和使用 Webhook。
• 操作指南：
  • how-to/local-dev – 本地 QStash 开发服务器（通过 QSTASH_DEV=true 自动启动）和隧道。
  • how-to/realtime – 实时工作流和人在环路中的工作流。
  • how-to/migrations – 安全迁移工作流。
  • how-to/middleware – 为工作流添加中间件。
• 其他文件：
  • rest-api – 用于与 QStash/Workflow 交互的底层 REST 端点。
  • troubleshooting – 常见调试和环境问题。
  • agents – 在 Agent、编排器和自动化模式中使用 Workflow。