Skip to main content
Version: v2

IStream Interface

Read interface for the Queue

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/driver-definitions/legacy.

For more information about our API support guarantees, see here.

Signature​

export interface IStream<T>

Type Parameters​

ParameterDescription
T

Methods​

MethodAlertsReturn TypeDescription
read()BetaPromise<IStreamResult<T>>

Method Details​

read​

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature​

read(): Promise<IStreamResult<T>>;

Returns​

Return type: Promise<IStreamResult<T>>