安装
npm install workflow适合谁
这份技能适合要在 TypeScript 或 JavaScript 里写「可持久」函数的人:官方写明它会保存工作流进度、重试失败步骤,并提供内建可观测性。它也适合已经在用 Next.js、准备在配置里接入官方封装的人。
它不适合只想在浏览器里直接启动工作流的人。原文把启动位置限定在 API 路由、Server Action 或其他服务端代码。若你还不能运行 npm,或不能接受一次本地装包,先停在阅读说明。
装包之后,编码代理可以从 node_modules/workflow/docs 阅读与当前版本匹配的指南。官方仓库见 https://github.com/vercel/workflow 请按该页已写出的命令操作。
3 分钟完成第一次尝试
只走官方写出的这一条安装路径。
前置条件:本机可以运行 npm,当前目录是一个允许写入依赖的项目。先确认:npm install workflow 会改依赖清单并下载软件包。若你还不想改这个项目,不要执行。
安装位置:在项目根目录打开终端,确认上述副作用后执行:
npm install workflow
低风险任务:装包完成后,不要急着在现网路由里启动工作流。先让编码代理只读打开 node_modules/workflow/docs,核对能否看到与当前版本匹配的本地指南,并找出 Next.js 应使用的导入语句。不要写入文件,不要对外发请求。
成功信号:项目依赖里出现 workflow 包,本地能打开 node_modules/workflow/docs,并且代理能指出官方导入 import { withWorkflow } from 'workflow/next'。若代理编造其他安装命令,回到上面的官方命令重试。
使用案例
案例一:给 Next.js 项目接上官方封装。原文给出的导入是 import { withWorkflow } from 'workflow/next'。适合已经有 Next.js 项目、想先核对配置入口的人。可先让代理只读标出应改的配置文件,确认后再写入。原文没有展开完整配置对象时,只做到「使用该导入」,不要自行补未出现的选项。
案例二:从服务端启动一段可持久的工作流。原文写明随后可以从 API 路由、Server Action 或其他服务端代码启动工作流。适合已经装好包、并且有一处服务端入口的人。第一次请先让代理指出准备从哪一个现有服务端入口启动,不要新建未说明的客户端入口。进度会持久化、失败步骤会重试;至于重试次数和观测面板怎么打开,原文没有写,不要补。
使用边界
官方安装命令只有一条被原文写出:npm install workflow。不要把未出现的安装器写进主路径。能力覆盖 TypeScript 和 JavaScript 函数的持久化、失败重试和内建可观测性,没有证明可用于其他语言。
启动位置只写到 API 路由、Server Action 或其他服务端代码。不要从浏览器或未点名的客户端直接启动。本地文档路径是 node_modules/workflow/docs,供编码代理阅读与版本匹配的指南;它没有给出客户端名单,不能据此写成某几个助手独占。
密钥、队列后端和生产观测账号原文没有展开。官方页面是 https://github.com/vercel/workflow 若代理建议的命令与该页不一致,以该页为准。