upstash-workflow-js

Upstash Workflow SDK

同梱ドキュメントとソースコード

SDK コードを作成またはデバッグする前に、同梱ドキュメントについては node_modules/@upstash/workflow/docs/ を、読みやすい TypeScript ソースコードについては node_modules/@upstash/workflow/src/ を確認してください。関連するファイルがある場合は、読み込んで検索してください。ない場合は、このスキルに記載されているリファレンスを使用してください。

クイックスタート

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、イベント、invoke など）。
  • 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 – エージェント、オーケストレーター、自動化パターンで Workflow を使用する方法。