Interface Stream<T>

interface Stream<T extends StreamDataType> {
getType(): string;
read(): Promise<StreamResponse<T>>;
}

Type Parameters

T extends StreamDataType

Index

Methods

Methods

getType

getType(): string

The type of data that the stream carries.

Returns string
string

read

read(): Promise<StreamResponse<T>>

Provides the next data chunk in the stream and rejects once all data has been read.

Returns Promise<StreamResponse<T>>