nhanh-pure-function/dist/File/index.d.ts

纯函数工具

/**
 * 读取文件
 * @param src 文件地址
 * @returns 文件的字符串内容
 */
export declare function _File_Read(src: string): Promise<string>;
/**
 * 下载文件并支持进度监控、超时控制和主动中止
 *
 * @param {Object} options - 下载配置选项
 * @param {string} options.href - 文件的 URL 路径或下载地址，需确保跨域权限或同源
 * @param {string} [options.fileName] - 可选，指定导出的文件名（不含扩展名时会自动从 href 提取）
 * @param {Function} [options.onProgress] - 可选，下载进度回调函数
 * @param {number} [options.onProgress.progress] - 进度百分比（0-100）
 * @param {number} [options.timeout=30000] - 可选，超时时间（毫秒），默认 30 秒
 * @param {boolean} [options.autoDownload=true] - 可选，是否自动执行下载操作，默认 true
 * @returns {Object} 返回包含以下属性的对象：
 *   - promise: Promise 对象，成功时 resolve 下载的 Blob 数据，失败时 reject 错误信息
 *   - abort: 中止下载的函数，调用后会触发 abort 错误
 *   - download: 手动执行下载的函数（当 autoDownload 为 false 时使用）
 */
export declare function _File_Download(options: {
    href: string;
    fileName?: string;
    onProgress?: (progress: number) => void;
    timeout?: number;
    autoDownload?: boolean;
}): {
    promise: Promise<Blob>;
    abort: () => false | void;
    download: () => void;
};
/**
 * 创建文件并下载
 * @param {BlobPart[]} content 文件内容
 * @param {string} fileName 文件名称
 * @param {BlobPropertyBag} options Blob 配置
 */
export declare function _File_CreateAndDownload(content: BlobPart[], fileName: string, options?: BlobPropertyBag): void;