Interface StreamResponse<I, O>

StreamResponse is used in interceptors to represent an ongoing call that has zero or more input messages, and zero or more output messages.

interface StreamResponse {
    header: Headers;
    message: AsyncIterable<O>;
    method: MethodInfo<I, O>;
    service: ServiceType;
    stream: true;
    trailer: Headers;
}

Type Parameters

Hierarchy

Properties

header message method service stream trailer

Properties

Readonly header

header: Headers

Headers received from the response.

Readonly message

message: AsyncIterable<O>

The output messages.

Readonly method

method: MethodInfo<I, O>

Metadata related to the service method that is being called.

Readonly service

service: ServiceType

Metadata related to the service that is being called.

Readonly stream

stream: true

The stream property discriminates between UnaryResponse and StreamingConn.

Readonly trailer

trailer: Headers

Trailers received from the response. Note that trailers are only populated when the entirety of the response has been read.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc