@Flow class with all lifecycle stage methods: pre, execute, post, finalize, and error.
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Generate a @Flow class extending FlowBase
@Flow class with all lifecycle stage methods: pre, execute, post, finalize, and error.
nx g @frontmcp/nx:flow audit-log --project crm
| Option | Type | Default | Description |
|---|---|---|---|
name | string | — | Required. The name of the flow |
project | string | — | Required. The project to add the flow to |
directory | string | — | Subdirectory within src/flows/ |
import { Flow, FlowBase } from '@frontmcp/sdk';
@Flow({
name: 'audit-log',
description: 'TODO: describe what this flow does',
plan: {
steps: ['pre', 'execute', 'post', 'finalize'],
},
})
export default class AuditLogFlow extends FlowBase {
async pre(): Promise<void> {
// TODO: pre-processing logic
}
async execute(): Promise<void> {
// TODO: main execution logic
}
async post(): Promise<void> {
// TODO: post-processing logic
}
async finalize(): Promise<void> {
// TODO: finalization logic
}
async error(err: Error): Promise<void> {
// TODO: error handling logic
throw err;
}
}