Interface FlowSideChannel<S>

Flow execution context for flow to access the streaming callback and side-channel context data. The context itself is a function, a short-cut for streaming callback.

interface FlowSideChannel<S> {
    context?: ActionContext;
    sendChunk: StreamingCallback<S>;
    trace: { spanId: string; traceId: string };
    (chunk: S): void;
}

Type Parameters

  • S
  • FlowSideChannel(chunk: S): void

  • Parameters

    • chunk: S

    Returns void

Properties

context? sendChunk trace

Properties

Optionalcontext

context?: ActionContext

Additional runtime context data (ex. auth context data).

sendChunk

sendChunk: StreamingCallback<S>

Streaming callback (optional).

trace

trace: { spanId: string; traceId: string }

Trace context containing trace and span IDs.

Settings

Member Visibility

On This Page

Properties