GramIO API Reference / @gramio/contexts/dist / StreamMessageOptions
Interface: StreamMessageOptions
Defined in: contexts/index.d.ts:346
Options for SendMixin.streamMessage
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
draftIdOffset? | number | Offset added to draft IDs. Defaults to 256 * updateId | contexts/index.d.ts:348 |
draftParams? | Omit<SendMessageDraftParams, "chat_id" | "draft_id" | "text" | "entities"> | Extra params for sendMessageDraft calls (e.g. parse_mode) | contexts/index.d.ts:350 |
messageParams? | Optional<SendMessageParams, "text" | "entities" | "chat_id"> | Extra params for sendMessage calls (e.g. reply_markup) | contexts/index.d.ts:352 |
signal? | AbortSignal | AbortSignal to cancel streaming | contexts/index.d.ts:359 |
throttle? | number | Minimum milliseconds between draft (preview) updates — used by the await using handle form (streamMessage()). Defaults to 1000. Ignored by the iterable form, which paces itself. | contexts/index.d.ts:357 |