@polyv/utils/es/image.d.ts

Utility functions of Polyv frontend development.

/**
 * 本模块提供图片操作相关方法。
 * @packageDocumentation
 */
/**
 * 检查当前浏览器是否支持 WebP 格式。
 * @returns 当前浏览器是否支持 WebP 格式。
 */
export declare const supportWebP: () => boolean;
/**
 * 检查当前浏览器是否支持 AVIF 格式（注意，本函数是异步函数）。
 * @returns 当前浏览器是否支持 AVIF 格式。
 */
export declare const supportAVIF: () => Promise<boolean>;
/**
 * 压缩选项。
 */
export interface IOSSCompressOptions {
    /**
     * 压缩后的图片宽度。
     */
    width?: number;
    /**
     * 压缩后的图片高度。
     */
    height?: number;
    /**
     * 是否允许转换为 JPG。默认为 true。
     */
    allowJPG?: boolean;
    /**
     * 是否允许转换为 WebP，默认为 'auto'。'auto' 表示当前浏览器支持 WebP，就进行转换。
     */
    allowWebP?: boolean | 'auto';
    /**
     * 是否允许转换为 AVIF。
     */
    allowAVIF?: boolean;
}
/**
 * 追加或替换 OSS 图片压缩参数。
 * @param url 指定图片 URL。
 * @param options 压缩选项或缩放的宽度。
 * @returns 处理后的图片 URL。
 * @example
 * ```javascript
 * ossCompress(url, 300);
 * ossCompress(url, {
 *   width: 300,
 *   allowJPG: true,
 *   allowWebP: 'auto'
 * });
 * ```
 */
export declare function ossCompress(url: string, options: IOSSCompressOptions | number): string;
/**
 * 追加或替换 COS 图片压缩参数。
 * @param url 指定图片 URL。
 * @param options 压缩选项或缩放的宽度。
 * @returns 处理后的图片 URL。
 */
export declare function cosCompress(url: string, options: IOSSCompressOptions | number): string;
/**
 * 对指定 HTML 代码中 img 标签的图片地址做 OSS 压缩处理。
 * @param html 指定 HTML 代码。
 * @param options 压缩选项。
 * @param compressor 压缩器。可以使用本模块下的 ossCompress 或 cosCompress，默认为 ossCompress。
 * @returns 处理后的 HTML 代码。
 */
export declare function compressHTMLImgs(html: string, options: IOSSCompressOptions, compressor?: (url: string, options: IOSSCompressOptions | number) => string): string;