Vite

npm install workflow

yarn add workflow

pnpm add workflow

import { defineConfig } from 'vite';
import { workflowHotUpdatePlugin } from 'workflow/vite';

export default defineConfig({
  plugins: [
    workflowHotUpdatePlugin()
  ]
});

{
  "compilerOptions": {
    "plugins": [
      {
        "name": "workflow"
      }
    ]
  }
}

​

How it works

• Hot module replacement (HMR) support for workflow files
• Automatic rebuild detection when workflow or step files change
• Detection of workflow patterns including:
  • "use workflow" and "use step" directives
  • @workflow/serde imports
  • Custom serialization patterns with Symbol.for('workflow-serialize')

​

Usage with frameworks

• Astro: Uses workflowHotUpdatePlugin for HMR
• SvelteKit: Uses workflowHotUpdatePlugin for HMR
• Nitro: Can optionally use the Vite plugin for development

​

Example workflow

import { sleep } from "workflow";

export async function processOrder(orderId: string) {
  "use workflow";

  await validateOrder(orderId);
  await sleep("5s");
  await fulfillOrder(orderId);

  return { orderId, status: "completed" };
}

async function validateOrder(orderId: string) {
  "use step";
  console.log(`Validating order ${orderId}`);
}

async function fulfillOrder(orderId: string) {
  "use step";
  console.log(`Fulfilling order ${orderId}`);
}

​

Next steps