Cloudflare Workflow

Use Cloudflare Workflow when Cloudflare should run the durable work for your app. You still define the workflow in your app, and ViteHub forwards run creation and run lookup to Cloudflare Workflows.

Before you start

Deploy the app on Cloudflare Workers so the workflow binding exists at runtime.

Configure Cloudflare

export default defineNuxtConfig({
  modules: ['@vitehub/workflow/nuxt'],
})

On Cloudflare hosting, ViteHub uses the Cloudflare workflow provider automatically.

Set workflow.binding only when you need a different binding name than the default, or when you want to pass an object that already has Cloudflare's create() and get() methods.

Define a workflow

Create a workflow file for the job you want to run.

export default defineWorkflow(async (input?: { title?: string }, context) => {
  const title = input?.title?.trim() || 'Untitled draft'

  return {
    provider: context?.provider,
    title,
  }
})

Start a workflow run

import { runWorkflow } from '@vitehub/workflow'

export default defineEventHandler(async () => {
  return await runWorkflow('publish-draft', {
    title: 'Ship weekly digest',
  })
})

If you call runWorkflow('publish-draft', payload), ViteHub forwards that payload to Cloudflare. When you do not provide your own params or payload start options, ViteHub writes the payload to Cloudflare's params field for you.

Cloudflare-specific options

What changes on Cloudflare