import { ImageFieldImage } from "@prismicio/types"; import { ImgixURLParams } from "imgix-url-builder"; /** * The return type of `asImageSrc()`. */ type AsImageSrcReturnType = Field extends ImageFieldImage<"filled"> ? string : null; /** * Returns the URL of an Image field with optional image transformations (via * Imgix URL parameters). * * @example * * ```ts * const src = asImageSrc(document.data.imageField, { sat: -100 }); * // => https://images.prismic.io/repo/image.png?sat=-100 * ``` * * @param field - Image field (or one of its responsive views) from which to get * an image URL. * @param params - An object of Imgix URL API parameters to transform the image. * * @returns The Image field's image URL with transformations applied (if given). * If the Image field is empty, `null` is returned. * @see Imgix URL parameters reference: https://docs.imgix.com/apis/rendering */ export declare const asImageSrc: (field: Field, params?: ImgixURLParams) => AsImageSrcReturnType; export {};