StreamIterator<T>

Namespace: Vercel.AI.Util

public sealed class StreamIterator<T>

Async iterator over a ReadableStream%601.

Type parameters

Name	Description
T

Inheritance: object

View source

Methods

NextAsync()

public Task<IteratorResult<T>> NextAsync()

Reads the next chunk.

Returns: Task<IteratorResult<T>>

View source

ReturnAsync()

public Task<IteratorResult<T>> ReturnAsync()

Stops iteration and cancels the stream.

Returns: Task<IteratorResult<T>>

View source

ThrowAsync(Exception)

public Task ThrowAsync(Exception error)

Stops iteration, cancels the stream, and throws <code class=“paramref”>error</code>.

Parameters

Name	Type	Description
error	Exception

Returns: Task

View source