@bitpatty/imgproxy-url-builder/dist/types/transformers/background.d.ts

A TypeScript helper library for building imgproxy URLs

/**
 * The background color
 */
type BackgroundOptions = string | {
    /**
     * The red channel (0-255)
     */
    r: number;
    /**
     * The green channel (0-255)
     */
    g: number;
    /**
     * The blue channel (0-255)
     */
    b: number;
};
/**
 * Fills the image background with the specified color.
 *
 * See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#background for the imgproxy documentation
 *
 * @param options  The background color (hex encoded string or RGB object)
 * @returns        The background param string
 */
declare const background: (options: BackgroundOptions) => string;
export default background;
export { BackgroundOptions };