chrono-forge/dist/decorators/Query.d.ts

A comprehensive framework for building resilient Temporal workflows, advanced state management, and real-time streaming activities in TypeScript. Designed for a seamless developer experience with powerful abstractions, dynamic orchestration, and full cont

import 'reflect-metadata';
export interface QueryOptions {
    /**
     * Custom name for the query. If not provided, the method name will be used.
     */
    name?: string;
    /**
     * Custom error handler for this specific query.
     * @param error The error that occurred during query execution
     * @returns A value to use as the query result, or throws to propagate the error
     */
    onError?: (error: Error) => any;
}
/**
 * Decorator that defines a method as a query handler within a workflow.
 * Queries provide a synchronous way to retrieve the current state or computed values
 * from a running workflow without modifying its state.
 *
 * ## Parameters
 * @param {string | QueryOptions} [options] - Optional configuration for the query.
 *   If a string is provided, it will be used as the query name.
 *   If an object is provided, it can contain:
 *   - name: Custom name for the query
 *   - onError: Custom error handler for the query
 *
 * ## Features
 * - **Synchronous Reading**: Provides immediate access to workflow state or computed values
 * - **Read-Only Operations**: Cannot modify workflow state
 * - **Consistent Results**: Returns data consistent with workflow history
 * - **Real-Time Monitoring**: Enables workflow state inspection without interruption
 *
 * ## Usage Examples
 *
 * ### Basic Query Handler
 * ```typescript
 * @Query()
 * getStatus(): string {
 *   return this.status;
 * }
 * ```
 *
 * ### Custom Named Query
 * ```typescript
 * @Query('workflowStatus')
 * getStatus(): string {
 *   return this.status;
 * }
 * ```
 *
 * ### Query with Options
 * ```typescript
 * @Query({
 *   name: 'workflowStatus',
 *   onError: (error) => {
 *     console.error('Query failed:', error);
 *     return null;
 *   }
 * })
 * getStatus(): string {
 *   return this.status;
 * }
 * ```
 *
 * ## Notes
 * - Query handlers must be synchronous or return a Promise
 * - Queries cannot modify workflow state
 * - Keep query handlers lightweight to avoid blocking
 * - Return serializable data for efficient communication
 *
 * @example
 * ```typescript
 * @Temporal()
 * class OrderWorkflow extends Workflow {
 *   private orderDetails: OrderDetails;
 *
 *   @Query()
 *   getOrderStatus(): OrderStatus {
 *     return {
 *       status: this.orderDetails.status,
 *       lastUpdated: this.orderDetails.lastUpdated,
 *       currentStep: this.orderDetails.currentStep
 *     };
 *   }
 * }
 * ```
 */
export declare const Query: (options?: string | QueryOptions) => (target: any, propertyKey: string) => void;