@prismicio/client/dist/helpers/asImageSrc.js

The official JavaScript + TypeScript client library for Prismic

import { imageThumbnail } from "./isFilled.js";
import { buildURL } from "imgix-url-builder";

//#region src/helpers/asImageSrc.ts
/**
* Returns the URL of an image field with optional image transformations via
* imgix URL parameters.
*
* @example
*
* ```ts
* const src = asImageSrc(document.data.photo, { sat: -100 })
* // => "https://images.prismic.io/repo/image.png?sat=-100"
* ```
*
* @param field - An image field (or one of its responsive views) from which to
*   get an image URL.
* @param config - An object of imgix URL API parameters to transform the image.
*
* @returns The image field's URL with transformations applied, or `null` if the
*   field is empty.
*
* @see Learn how to optimize images with imgix: {@link https://prismic.io/docs/fields/image}
* @see imgix URL parameters reference: {@link https://docs.imgix.com/apis/rendering}
*/
const asImageSrc = (field, config = {}) => {
	if (field && imageThumbnail(field)) return buildURL(field.url, config);
	else return null;
};

//#endregion
export { asImageSrc };
//# sourceMappingURL=asImageSrc.js.map