Interface StreamOutput<T>

StreamOutput is the streaming response declaration attached to an operation via output: stream(...). The kind discriminator lets the runtime distinguish Schema<Out> from StreamOutput<Out>.

interface StreamOutput<T> {
    kind: "stream";
    mediaType: string;
    itemSchema?: Schema<T>;
    encoder?: StreamEncoder<T>;
}

Type Parameters

T

Index

Properties

kind mediaType itemSchema? encoder?

Properties

`Readonly`kind

kind: "stream"

`Readonly`mediaType

mediaType: string

`Optional` `Readonly`itemSchema

itemSchema?: Schema<T>

`Optional` `Readonly`encoder

encoder?: StreamEncoder<T>