Interface StreamRequest<I, O>

StreamRequest is used in interceptors to represent a request that has zero or more input messages, and zero or more output messages.

interface StreamRequest<I, O> {
    contextValues: ContextValues;
    header: Headers;
    init: RequestInit;
    message: AsyncIterable<I>;
    method: MethodInfo<I, O>;
    service: ServiceType;
    signal: AbortSignal;
    stream: true;
    url: string;
}

Type Parameters

Hierarchy (view full)

Properties

contextValues header init message method service signal stream url

Properties

Readonly contextValues

contextValues: ContextValues

The context values for the current call.

Readonly header

header: Headers

Headers that will be sent along with the request.

Readonly init

init: RequestInit

Optional parameters to the fetch API.

Readonly message

message: AsyncIterable<I>

The input messages that will be transmitted.

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 signal

signal: AbortSignal

The AbortSignal for the current call.

Readonly stream

stream: true

The stream property discriminates between UnaryRequest and StreamingRequest.

Readonly url

url: string

The URL the request is going to hit.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc