workflow
Version:
Workflow SDK - Build durable, resilient, and observable workflows
32 lines (27 loc) • 1.46 kB
text/mdx
title: "workflow/nest"
description: NestJS integration for workflow bundling and HTTP routing.
type: overview
summary: Explore the NestJS integration for workflow bundle building and runtime routing.
related:
- /docs/getting-started/nestjs
NestJS integration for Workflow SDK. The `WorkflowModule` builds the workflow bundles on application startup and registers the controller that serves the workflow runtime routes.
<Callout>
NestJS integration is experimental and not yet supported for deployment to Vercel. The same exports are also available from the `@workflow/nest` package.
</Callout>
## Exports
<Cards>
<Card title="WorkflowModule" href="/docs/api-reference/workflow-nest/workflow-module">
NestJS module that builds workflow bundles on startup and registers the workflow controller
</Card>
<Card title="NestLocalBuilder" href="/docs/api-reference/workflow-nest/nest-local-builder">
Builder that compiles workflow files into step, workflow, and webhook bundles
</Card>
<Card title="WorkflowController" href="/docs/api-reference/workflow-nest/workflow-controller">
Controller that serves the workflow runtime routes under `.well-known/workflow/v1`
</Card>
<Card title="configureWorkflowController()" href="/docs/api-reference/workflow-nest/configure-workflow-controller">
Points `WorkflowController` at the directory containing the generated workflow bundles
</Card>
</Cards>