Interface FlowResult

Describes an observed Flow status and its output-bearing completions.

interface FlowResult {
    completions: readonly StepCompletion[];
    errorMessage: string | undefined;
    errorType: FlowErrorType | undefined;
    isTerminal: boolean;
    status: FlowStatus;
    singleOutput<Output>(codec?: Codec<Output>): Output;
}

Index

Properties

completions errorMessage errorType isTerminal status

Methods

Properties

`Readonly`completions

completions: readonly StepCompletion[]

Immutable completions in server collection order. Parallel Step order is not deterministic.

`Readonly`errorMessage

errorMessage: string | undefined

Server failure detail when available.

`Readonly`errorType

errorType: FlowErrorType | undefined

Dex failure category when available.

`Readonly`isTerminal

isTerminal: boolean

Whether the observed run is terminal.

`Readonly`status

status: FlowStatus

Observed lifecycle state. A running SubFlow value is a durable snapshot.

Methods

singleOutput

singleOutput<Output>(codec?: Codec<Output>): Output
Decodes the output when exactly one completion exists.
Type Parameters
- Output
  Expected application output type.
Parameters
- Optionalcodec: Codec<Output>
  Codec for the expected output type. Omit this for JSON objects. Scalar wire kinds still need an explicit codec.
Returns Output
The only decoded Step output.

Throws
TypeError when nonterminal or when zero or multiple outputs exist.