@ivujs/i-utils/dist/es/file/index.d.ts

前端模块化 JavaScript 工具库

/**
 * 格式化文件大小自动转为 B，KB，MB，GB
 * @param {number} size 文件的大小，单位byte字节
 * @returns {string} 返回格式化后的字符串
 */
export declare function formatFileSize(size: number): string;
/**
 * 获得文件名称
 * @param {string} fileName 文件的全名称，例如：测试图片.jpg
 * @returns {string} 返回文件的名称
 */
export declare function getFileName(fileName: string): string | undefined;
/**
 * 获得文件后缀名
 * @param {string} value 文件地址路径或者文件全名称，例如：http://xxx.com/mytest.jpg，测试图片.jpg
 * @returns {string} 返回文件后缀名
 */
export declare function getFileSuffix(value: string): string | undefined;
/**
 * file转blob
 * @param {File} file file文件
 * @returns {Promise} 返回Promise的blob
 */
export declare function fileToBlob(file: File): Promise<Blob>;
/**
 * file转base64
 * @param {File} file file文件
 * @returns {Promise} 返回Promise的base64
 */
export declare function fileToBase64(file: File): Promise<string>;
/**
 * file转url
 * @description 适用于本地上传图片并预览，需要注意 URL.revokeObjectURL(file) 内存释放
 * @param {File} file file文件
 * @returns {Promise} 返回Promise的url
 */
export declare function fileToUrl(file: File): Promise<string>;
/**
 * url赚file
 * @param {string} url url地址
 * @returns {Promise} 返回Promise的file
 */
export declare function urlToFile(url: string): Promise<File>;
/**
 * blob转file
 * @param {Blob} blob blob数据
 * @param {string} fileName 文件名称，默认以时间戳命名
 * @returns {Promise} 返回Promise的file
 */
export declare function blobToFile(blob: Blob, fileName?: string): Promise<File>;
/**
 * blob转文本
 * @param {Blob} blob blob数据
 * @returns {Promise} 返回Promise的文本
 */
export declare function blobToText(blob: Blob): Promise<string>;
/**
 * blob转base64
 * @param {Blob} blob blob数据
 * @returns {Promise} 返回Promise的base64
 */
export declare function blobToBase64(blob: Blob): Promise<string>;
/**
 * base64转file
 * @param {string} base64 base64数据
 * @param {string} fileName 文件名称，默认以时间戳命名
 * @returns {Promise} 返回Promise的file
 */
export declare function base64ToFile(base64: string, fileName?: string): Promise<File>;
/**
 * base64转成blob
 * @param {string} base64 base64数据
 * @returns {Promise} 返回Promise的blob
 */
export declare function base64ToBlob(base64: string): Promise<Blob>;
/**
 * 图片url转base64
 * @param {string} imgUrl 图片url地址
 * @returns {Promise} 返回Promise的base64
 */
export declare function urlToBase64(imgUrl: string): Promise<string>;
/**
 * 下载blob格式的文件
 * @param {Blob} blob blob数据
 * @param {string} fileName 下载的文件名，不写后缀名则默认为原文件类型
 */
export declare function downloadBlobFile(blob: Blob, fileName: string): void;
/**
 * 通过文件url地址下载
 * @param {string} fileUrl url文件地址
 * @param {string} fileName 下载的文件名，不写后缀名则默认为原文件类型
 */
export declare function downloadFileUrl(fileUrl: string, fileName: string): void;