@microsoft/teams.apps/dist/types/streamer.d.ts

<p> <a href="https://www.npmjs.com/package/@microsoft/teams.apps" target="_blank"> <img src="https://img.shields.io/npm/v/@microsoft/teams.apps/latest" /> </a> <a href="https://www.npmjs.com/package/@microsoft/teams.apps?activeTab=code

import { IMessageActivity, ITypingActivity, SentActivity } from '@microsoft/teams.api';
import { IEventEmitter } from '@microsoft/teams.common';
/**
 * the minimum events a streamer
 * should support
 */
export interface IStreamerEvents {
    /**
     * emitted for each chunk sent
     */
    readonly chunk: SentActivity;
    /**
     * emitted once on stream close
     */
    readonly close: SentActivity;
}
/**
 * component that can send streamed chunks of an activity
 */
export interface IStreamer {
    readonly events: Omit<IEventEmitter<IStreamerEvents>, 'emit'>;
    /**
     * emit an activity chunk
     * @param activity the activity to send
     */
    emit(activity: Partial<IMessageActivity | ITypingActivity> | string): void;
    /**
     * send status updates before emitting (ex. "Thinking...")
     * @param text the status text to send
     */
    update(text: string): void;
    /**
     * close the stream
     */
    close(): SentActivity | undefined | Promise<SentActivity | undefined>;
}