STREAM_CURRENT_ATTRIBUTE
Attribute revealStream keeps on the block it showed last, while it runs.
import { STREAM_CURRENT_ATTRIBUTE } from "@sdxc/ui/chat";Signature
const STREAM_CURRENT_ATTRIBUTE = "data-stream-current"Used with it
The events, constants and types its module publishes, each imported from @sdxc/ui/chat too.
Interface
StreamRevealOptions
Options for revealStream.
| Member | Type | Required | Description |
|---|---|---|---|
interval | number | No | Milliseconds between ticks. @default 32 |
onEnd | (end: StreamRevealEnd) => void | No | Called once, when the whole reply has shown or StreamReveal.stop ran. |
signal | AbortSignal | No | Stops the reveal where it is when aborted, as StreamReveal.stop does. |
Interface
StreamReveal
A running reveal.
| Member | Type | Required | Description |
|---|---|---|---|
stop | void | Yes | Freezes the reply at what has shown; the rest of it stays out of the page. |
Type
StreamRevealEnd
How a reveal finished.
type StreamRevealEnd = "done" | "stopped"