Skip to main content
Defined in: streaming/types.ts:43 Options of ctx.stream() / streamText.

​
Properties

​
strategy?

Defined in: streaming/types.ts:45 'auto' (default) picks from capabilities.streaming; an unsupported choice degrades.

​
throttleMs?

Defined in: streaming/types.ts:47 Minimum ms between two live updates (draft/edit). Default 400 (draft), 1000 (edit).

​
signal?

Defined in: streaming/types.ts:49 Abort the stream: reading stops and the source’s return() is called.

​
onCancel?

Defined in: streaming/types.ts:57 What to do with the text produced so far on cancellation. Default 'flush' (send it). 'discard' sends nothing more and removes the live preview: a draft simply expires and, with the edit strategy, the message being edited is deleted (when the transport can delete; otherwise only its cursor is removed). Messages already completed before the cancel stay.

​
maxLength?

Defined in: streaming/types.ts:59 Max chars per message. Default capabilities.maxTextLength, else 4096 (capabilities.maxTextBytes also applies).

​
minChunkChars?

Defined in: streaming/types.ts:61 'chunk': minimum chars before a chunk is sent at a sentence boundary. Default 160.

​
maxChunkChars?

Defined in: streaming/types.ts:63 'chunk': hard size of a chunk with no sentence boundary. Default min(maxLength, 1500).

​
typing?

Defined in: streaming/types.ts:65 Show typing while waiting (chunk/buffer, and edit before its first message). Default true.

​
typingIntervalMs?

Defined in: streaming/types.ts:67 Interval (ms) to refresh the typing indicator. Default 8000.

​
cursor?

Defined in: streaming/types.ts:69 Suffix shown on in-progress drafts/edits (e.g. ' ▌'). Never in the final text. Default ''.

​
canStop?

Defined in: streaming/types.ts:71 Draft: show a stop button (Telegram can_stop). Default false.

​
keepOnStop?

Defined in: streaming/types.ts:73 Draft: keep the draft visible when the user stops it (Telegram keep_on_stop).

​
sendOptions?

Defined in: streaming/types.ts:75 Options for the FIRST message sent (e.g. { quoted: ctx.ref }).

​
draftPlatformData?

Defined in: streaming/types.ts:77 Transport passthrough for draft calls (e.g. Telegram message_thread_id).