koishi-plugin-royale/lib/utils/response.d.ts

Clash Royale信息查询

/**
 * 标准响应接口
 */
export interface PluginResponse<T = any> {
    /**
     * 响应状态：true 表示成功，false 表示失败
     */
    success: boolean;
    /**
     * 响应消息：为用户展示的文本内容
     */
    message: string;
    /**
     * 响应数据：可以是任何类型，根据插件的功能不同而不同
     */
    data?: T;
    /**
     * 错误信息：当响应失败时提供的错误详情
     */
    error?: string;
}
/**
 * 创建成功响应
 * @param message 响应消息
 * @param data 响应数据
 * @returns 标准化的成功响应
 */
export declare function success<T>(message: string, data?: T): PluginResponse<T>;
/**
 * 创建失败响应
 * @param message 响应消息
 * @param error 错误详情
 * @returns 标准化的失败响应
 */
export declare function failure(message: string, error?: string): PluginResponse;
/**
 * 将标准响应对象格式化为字符串
 * @param response 标准响应对象
 * @returns 格式化后的响应字符串
 */
export declare function formatResponse(response: PluginResponse): string | any;