@botmesh/core - v2.0.0-alpha.2
    Preparing search index...

    Interface StreamTarget

    The sink streamText renders into. ctx.stream() builds one from the bot; tests and custom integrations can provide their own.

    interface StreamTarget {
        capabilities?: Pick<
            ProviderCapabilities,
            "edit"
            | "streaming"
            | "maxTextLength"
            | "maxTextBytes",
        >;
        isPrivate?: boolean;
        send(
            content: OutboundContent,
            options?: SendOptions,
        ): Promise<SentMessage<unknown>>;
        edit?(ref: MessageRef, content: OutboundContent): Promise<unknown>;
        delete?(ref: MessageRef): Promise<void>;
        draft?(draftId: number, text: string, opts?: DraftOptions): Promise<void>;
        typing?(): Promise<void>;
        shutdown?: AbortSignal;
    }
    Index
    capabilities? isPrivate? shutdown?
    send edit? delete? draft? typing?
    capabilities?: Pick<
        ProviderCapabilities,
        "edit"
        | "streaming"
        | "maxTextLength"
        | "maxTextBytes",
    >
    isPrivate?: boolean

    false for groups/channels: native drafts are attempted only when not false.

    shutdown?: AbortSignal

    Aborted when the transport shuts down (bot.stop()): the stream is cancelled and touches the target no more — no flush, no discard, no rate-limit wait.

    Settings
    Member Visibility

    On This Page
    Properties
    Methods