payload/dist/utilities/getBestFitFromSizes.d.ts

Node, React, Headless CMS and Application Framework built on Next.js

/**
 * Takes image sizes and a target range and returns the url of the image within that range.
 * If no images fit within the range, it selects the next smallest adequate image, the original,
 * or the largest smaller image if no better fit exists.
 *
 * @param sizes The given FileSizes.
 * @param targetSizeMax The ideal image maximum width. Defaults to 180.
 * @param targetSizeMin The ideal image minimum width. Defaults to 40.
 * @param thumbnailURL The thumbnail url set in config. If passed a url, will return early with it.
 * @param url The url of the original file.
 * @param width The width of the original file.
 * @returns A url of the best fit file.
 */
export declare const getBestFitFromSizes: ({ sizes, targetSizeMax, targetSizeMin, thumbnailURL, url, width, }: {
    sizes?: Record<string, {
        url?: string;
        width?: number;
    }>;
    targetSizeMax?: number;
    targetSizeMin?: number;
    thumbnailURL?: string;
    url: string;
    width?: number;
}) => string;
//# sourceMappingURL=getBestFitFromSizes.d.ts.map