configureWorkflowController

Configures the output directory that WorkflowController loads the generated workflow bundles (steps.mjs, workflows.mjs, webhook.mjs, manifest.json) from.

Deprecated. WorkflowModule.forRoot() provides the output directory through dependency injection, which this function predates. It writes process-global state, so two applications in one process (the usual Test.createTestingModule setup) overwrite each other's configuration. It is kept only so existing callers keep working.

WorkflowModule.forRoot() still calls this for you, and injected options take precedence over it. Call it yourself only when registering WorkflowController without the module. A controller with no configuration at all answers 503 with an explanatory message.

Usage

src/app.module.ts

import { join } from "node:path";
import { configureWorkflowController } from "workflow/nest";

configureWorkflowController(join(process.cwd(), ".nestjs/workflow"));

API signature

Parameters

Parameter	Type	Description
`outDir`	`string`	Directory containing the generated workflow bundles. Should match the `outDir` used by the builder (default: `.nestjs/workflow` in the working directory).

Returns

Returns void.