UNPKG

@bitpatty/imgproxy-url-builder

Version:

A TypeScript helper library for building imgproxy URLs

37 lines (36 loc) 932 B
import GravityType from '../enums/gravity-type.enum.js'; /** * The extend options */ type ExtendOptions = { /** * The gravity */ gravity: { type: Exclude<GravityType, GravityType.SMART>; /** * The gravity offset */ offset?: { /** * The gravity offset on the X axis */ x: number; /** * The gravity offset on the y axis */ y: number; }; }; }; /** * Extends the image if it is smaller than the given size. * * See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#extend for the imgproxy documentation * * @param options The extend options * @returns The extend param string */ declare const extend: (options?: ExtendOptions) => string; export default extend; export { ExtendOptions };