@polyv/utils/cjs/file.d.ts

Utility functions of Polyv frontend development.

/**
 * 本模块提供文件处理相关方法。
 * @packageDocumentation
 */
/**
 * 文件体积单位。
 */
export declare enum FileSizeUnit {
    B = "B",
    KB = "KB",
    MB = "MB",
    GB = "GB",
    TB = "TB"
}
/**
 * 文件体积转换选项。
 */
export interface FileSizeConversionOptions {
    /**
     * 目标单位。
     */
    unit: FileSizeUnit;
    /**
     * 是否允许纯小数。
     * 如果不允许，则在保证转换目标值大于 1 的前提下，以距离目标单位最近的单位进行转换。
     * 默认为允许。
     */
    allowPureDecimal?: boolean;
}
/**
 * 文件体积转换结果。
 */
export interface FileSizeConversionResult {
    /**
     * 转过结果的值。
     */
    value: number;
    /**
     * 转换结果的单位。
     */
    unit: FileSizeUnit;
}
/**
 * 转换文件体积。
 * @param sizeInBytes 以字节为单位的文件体积值。
 * @param options 转换选项。
 * @returns 转换结果。
 */
export declare function convertFileSize(sizeInBytes: number, options: FileSizeUnit | FileSizeConversionOptions): FileSizeConversionResult;