@node-ts/bus-workflow/dist/workflow/decorators/handles.d.ts

A workflow engine for orchestrating logic flows in distributed applications.

import { Message, MessageAttributes } from '@node-ts/bus-messages';
import { WorkflowData } from '../workflow-data';
import { MessageWorkflowMapping } from '../message-workflow-mapping';
import { Workflow, WorkflowConstructor } from '../workflow';
import { WorkflowWithHandler } from './handler-workflow';
import { ClassConstructor } from '@node-ts/bus-core';
export declare const WORKFLOW_HANDLES_METADATA_KEY: unique symbol;
export declare class WorkflowHandlesMetadata<WorkflowDataType extends WorkflowData = WorkflowData> {
    propertyKey: string;
    messageConstructor: ClassConstructor<Message>;
    messageWorkflowMapping: MessageWorkflowMapping<Message, WorkflowDataType>;
    static addStep<WorkflowDataType extends WorkflowData>(metadata: WorkflowHandlesMetadata<WorkflowDataType>, target: Workflow<WorkflowDataType>): void;
    static getSteps(target: WorkflowConstructor<WorkflowData>): WorkflowHandlesMetadata[];
}
/**
 * Flags that a function within a workflow handles a message of a particular type. When a message
 * of this type is received from the bus, the `messageLookup` function will be executed for all
 * workflow types that have functions decorated with `Handles` for that message type.
 * @param messageConstructor The message that this function handles
 * @param messageLookup A function that returns a value based on the message used to look up workflow data by
 * @param workflowDataProperty A field in the workflow data to look up matched message data on
 */
export declare function Handles<TMessage extends Message, WorkflowDataType extends WorkflowData, KeyType extends string, TargetType extends WorkflowWithHandler<TMessage, WorkflowDataType, KeyType> = WorkflowWithHandler<TMessage, WorkflowDataType, KeyType>>(messageConstructor: ClassConstructor<TMessage>, messageLookup: (message: TMessage, messageOptions: MessageAttributes) => string | undefined, workflowDataProperty: keyof WorkflowDataType): (target: TargetType, propertyKey: KeyType) => void;