@ahoo-wang/fetcher-wow/dist/command/commandResult.d.ts

Support for Wow(https://github.com/Ahoo-Wang/Wow) in Fetcher

import { AggregateId, AggregateIdCapable, AggregateNameCapable, ErrorInfo, FunctionInfoCapable, Identifier, NamedBoundedContext } from '../types';
import { CommandId, CommandResultCapable, CommandStageCapable, NullableAggregateVersionCapable, RequestId, SignalTimeCapable, WaitCommandIdCapable } from './types';
import { JsonServerSentEvent } from '@ahoo-wang/fetcher-eventstream';
/**
 * Represents a signal that waits for command execution completion.
 *
 * This interface combines multiple capabilities to provide comprehensive information
 * about a command that is being waited upon, including identification, timing,
 * execution results, and error information.
 *
 * It extends several interfaces to aggregate different aspects of command execution:
 * - Identifier: Provides unique identification
 * - WaitCommandIdCapable: Contains the ID of the command being waited for
 * - CommandId: Contains the command ID
 * - AggregateIdCapable: Provides the aggregate ID associated with the command
 * - NullableAggregateVersionCapable: Contains optional aggregate version for concurrency control
 * - ErrorInfo: Contains error information if command execution failed
 * - SignalTimeCapable: Provides timestamp information
 * - CommandResultCapable: Contains the actual command execution result
 * - FunctionInfoCapable: Provides information about the function that processed the command
 */
export interface WaitSignal extends Identifier, WaitCommandIdCapable, CommandId, AggregateIdCapable, NullableAggregateVersionCapable, ErrorInfo, SignalTimeCapable, CommandResultCapable, FunctionInfoCapable {
}
/**
 * Command execution result interface
 *
 * Represents the result of a command execution, containing information about:
 * - Command identification (commandId, requestId)
 * - Execution context (bounded context, aggregate information)
 * - Execution status and errors
 * - Timing information (signalTime)
 * - Version tracking (aggregateVersion)
 */
export interface CommandResult extends Identifier, WaitCommandIdCapable, CommandStageCapable, NamedBoundedContext, AggregateNameCapable, AggregateId, ErrorInfo, CommandId, RequestId, ErrorInfo, FunctionInfoCapable, CommandResultCapable, SignalTimeCapable, NullableAggregateVersionCapable {
}
/**
 * Command result event stream type
 *
 * A readable stream of JSON Server-Sent Events containing command execution results.
 * This stream allows real-time consumption of command results as they are processed.
 *
 * @example
 * ```typescript
 * const eventStream: CommandResultEventStream = getCommandResultStream();
 * for await (const event of eventStream) {
 *   const commandResult: CommandResult = event.data;
 *   console.log('Command result received:', commandResult);
 * }
 * ```
 */
export type CommandResultEventStream = ReadableStream<JsonServerSentEvent<CommandResult>>;
//# sourceMappingURL=commandResult.d.ts.map