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
| Parameter | Description |
|---|---|
| T |
Methods
| Method | Alerts | Return Type | Description |
|---|---|---|---|
| read() | Alpha |
Promise<IStreamResult<T>> |
Method Details
read
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/driver-definitions/alpha.
For more information about our API support guarantees, see here.
Signature
read(): Promise<IStreamResult<T>>;
Returns
Return type: Promise<IStreamResult<T>>