UseStreamReturn
Defined in: react-hooks/src/use-stream.ts:28
Stream hook return value.
Properties
Section titled “Properties”error:
Error|undefined
Defined in: react-hooks/src/use-stream.ts:34
Error if any
isStreaming
Section titled “isStreaming”isStreaming:
boolean
Defined in: react-hooks/src/use-stream.ts:32
Whether streaming is active
reset()
Section titled “reset()”reset: () =>
void
Defined in: react-hooks/src/use-stream.ts:44
Reset state
Returns
Section titled “Returns”void
setText()
Section titled “setText()”setText: (
text) =>void
Defined in: react-hooks/src/use-stream.ts:46
Manually set text
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
startAsyncIterable()
Section titled “startAsyncIterable()”startAsyncIterable: (
iterable) =>Promise<string>
Defined in: react-hooks/src/use-stream.ts:40
Start streaming from an async iterable
Parameters
Section titled “Parameters”iterable
Section titled “iterable”AsyncIterable<string>
Returns
Section titled “Returns”Promise<string>
startReadableStream()
Section titled “startReadableStream()”startReadableStream: (
stream) =>Promise<string>
Defined in: react-hooks/src/use-stream.ts:38
Start streaming from a ReadableStream
Parameters
Section titled “Parameters”stream
Section titled “stream”ReadableStream<Uint8Array<ArrayBufferLike>>
Returns
Section titled “Returns”Promise<string>
startStream()
Section titled “startStream()”startStream: (
response) =>Promise<string>
Defined in: react-hooks/src/use-stream.ts:36
Start streaming from a response
Parameters
Section titled “Parameters”response
Section titled “response”Response
Returns
Section titled “Returns”Promise<string>
stop()
Section titled “stop()”stop: () =>
void
Defined in: react-hooks/src/use-stream.ts:42
Stop streaming
Returns
Section titled “Returns”void
text:
string
Defined in: react-hooks/src/use-stream.ts:30
Current streamed text