adk-typescript/dist/agents/ActiveStreamingTool.d.ts

TypeScript port of Google's Agent Development Kit (ADK)

/**
 * Represents an active streaming tool that is running.
 */
export declare class ActiveStreamingTool {
    /** The task Promise */
    task: Promise<void> | Promise<any> | null;
    /** Whether the task is done */
    done: boolean;
    /** Whether the task has been cancelled */
    cancelled: boolean;
    /** Function name */
    name?: string;
    /** Function arguments */
    args?: Record<string, any>;
    /** Function ID */
    id?: string;
    /** The result of the function, if completed */
    result?: any;
    /**
     * Creates a new instance of ActiveStreamingTool.
     *
     * @param task The task Promise
     * @param options Additional options
     */
    constructor(task: Promise<void> | Promise<any> | null, options?: {
        name?: string;
        args?: Record<string, any>;
        id?: string;
        done?: boolean;
        cancelled?: boolean;
    });
    /**
     * Marks the streaming tool as completed.
     *
     * @param result The result of the function.
     */
    complete(result: any): void;
    /**
     * Marks the streaming tool as cancelled.
     */
    cancel(): void;
}