Interface StreamingDraft

interface StreamingDraft {
    randomId: Long;
    signal?: AbortSignal;
    get finalText(): TextWithEntities;
    "[dispose]"(): void;
    dispose(): void;
    send(text: InputText): Promise<void>;
}

Index

Properties

randomId signal?

Accessors

Methods

[dispose] dispose send

Properties

`Readonly`randomId

randomId: Long

Random ID of the draft

`Optional` `Readonly`signal

signal?: AbortSignal

Signal that is aborted once the user stops the draft generation. Only present if canStop was passed, requires updates to be enabled

Accessors

finalText

get finalText(): TextWithEntities
Final text of the draft, for convenience

Returns TextWithEntities
- Defined in packages/core/src/highlevel/methods/messages/create-streaming-draft.ts:22

Methods

[dispose]

"[dispose]"(): void
Returns void
- Defined in packages/core/src/highlevel/methods/messages/create-streaming-draft.ts:30

dispose

dispose(): void
Stop listening for the user stopping the draft. Call once the draft is no longer needed

Returns void
- Defined in packages/core/src/highlevel/methods/messages/create-streaming-draft.ts:29

send

send(text: InputText): Promise<void>
Depending on the mode, this method will either append or replace the draft. Does nothing once the draft was stopped by the user
Parameters
- text: InputText
Returns Promise<void>
- Defined in packages/core/src/highlevel/methods/messages/create-streaming-draft.ts:20