The Workflow class in ChronoForge is the foundational component for defining Temporal workflows using TypeScript. It provides a powerful framework for managing workflow execution, handling signals and queries, applying lifecycle hooks, and processing complex step sequences. This class extends EventEmitter to provide event-based communication within the workflow, enabling robust state management and execution control.
The core philosophy behind the Workflow class is to simplify the development of Temporal workflows by providing a structured, decorator-based approach that abstracts away many of the complexities of workflow definition, execution, and error handling. It enables developers to focus on business logic while the framework handles the intricacies of workflow orchestration.
- Decorator-Based Workflow Definition: A comprehensive set of decorators (
@Temporal,@Signal,@Query, etc.) that simplify workflow definition and management. - Signal and Query Handling: Built-in support for defining and managing signals and queries using decorators.
- Lifecycle Hooks: Flexible lifecycle management through
@Hook,@Before, and@Afterdecorators. - Step-Based Execution: Complex workflow steps with dependencies, conditions, and error handling via the
@Stepdecorator. - Action System: Type-safe business logic operations using the
@Actiondecorator. - Event-Based Communication: Integrated EventEmitter functionality for event-driven workflow design.
- Child Workflow Management: Support for creating and managing child workflows.
- Execution Flow Control: Built-in capabilities to pause, resume, and cancel workflows.
- Continuation Support: Handling of workflow continuation through the
continueAsNewmechanism. - Structured Logging: Integrated logging with workflow context information.
- OpenTelemetry Integration: Built-in tracing for monitoring and debugging workflow execution.
- Error Handling: Comprehensive error management with retry capabilities.